DroidBasic's Language Reference DroidBasic comes with extensive documentation, with hypertext cross-references throughout, so you can easily click your way to whatever interests you. The part of the documentation that you will probably use the most is the this Language Reference. Each link provides a different way of navigating the this Language Reference; try them all to see which work best for you. DroidBasic ships with lots of small and some medium-sized example programs that teach you how to implement various tasks. Most of them will show how to use a certain class or module, others aim at programming techniques and basics, and some of them simply want to show you what is possible. If you would like to send a comment or an example, please write to mailto:sales@droidbasic.com. This new framework provides many improvements and enhancements over previous releases. This overview covers the most important features. DroidBasic will be continuously improved as a result of feedback and suggestions from customers and the open source community. Last edit on 2012-10-31 10:00:41

Subs & Functions Objects Classes Inheritance Tree Controls Keywords Types Constants Operators Operator Order Sub-Classing Control Flow & Structure Comments Literals Appendix: Way of naming Appendix: List of Java Keywords Appendix: Syntax of Arguments

Subs & Functions

Sub-procedures contain commands and statements, but do not return a value or cannot be used in expressions. The following built-in subs are predefined subs, which has a special meaning and which meaning cannot be changed. Some of them are provided for VB6 backward compatibility.A function-procedure is like a sub-procedure, but it can return a value. That is the only difference between them. The following built-in functions are predefined functions, which has a special meaning and which meaning cannot be changed. Some of them are provided for VB6 backward compatibility.

Abs Alert Append Asc At Atn BitClr BitSet BitTst CBool CByte CDbl CInt CLng CShort CSng Character Chr ClassName Compare Contains Cos Count EndsWith Exp Fact FileExtension FileName FilePath Fix Format FormatFloat Hex InStr InStrRev IndexOf Int IsBoolean IsByte IsDouble IsEqualClass IsEqualObject IsEqualValue IsFloat IsInt16 IsInt32 IsInt64 IsInt8 IsInteger IsShort IsSingle IsString LCase LastIndexOf Left Len Length Ln Log10 Lower Max Min MsgBox Nz Prepend QStringList RND Random Randomize ReadArray ReadDictionary ReadObject Replace Reversed Right Round Sin Space Sqr StartsWith Str StrReverse Tan Trim Trimmed UCase Unicode Upper WriteArray WriteDictionary WriteObject

The following list contains the init functions.

Activity Boolean Bundle Button CheckBox CompoundButton Double Float Integer Long Object RadioButton Single String TextView View id

Objects

The following list contains the built-in objects.

SystemClock

Classes

Classes are needed, when you would like create objects. The following list contains the built-in classes.

Activity Bundle Button CheckBox CompoundButton Object RadioButton TextView View

Inheritance Tree

Built-in Java/Android classes are listed. Object is the root class of most classes.

Object

• Activity
• Bundle
• View
• TextView
• Button
• CompoundButton
• CheckBox
• RadioButton

Non Object-based classes (flat view)

Controls and DroidBasic classes

There are provided to get abbreviations for common Java/Android classes and features.

Control

Keywords

A keyword is a predefined identifier, which has a special meaning for DroidBasic and which meaning cannot be changed. The following list contains all DroidBasic keywords. Be aware that keywords are case sensitive, which means you must it write with the same lowercase or uppercase letters everywhere. Some of them are provided for backward compatibility.

</java> </string> <java> <string> Action Alias As Break ByRef ByVal Call Case Catch Class Const Continue Declare Dim Do Else End Event Exception Exit False Finally For Function Global IIf If Is Iterate Loop Me Mid Module Next Null Outlet Private Public Return Select Signal Static Step Sub Super SuperClass Then Then To True Try Until Var While

Types

Like a file, a variable has a name (used to access the variable and to identify it). Additional, it has also a data type to specify the type of information a variable holds. So data types describe the type of data stored inside a variable. If you declare a variable you must also give it a data type. Unlike built-in classes, the following types cannot be used as super class for custom classes.

Boolean Double Float Integer Long Object Single String id

Constants

Constants are similar to variables but they cannot change values. When you declare a constant you assign a value to it that cannot be altered during the lifetime of your program.

CaseInsensitive CaseSensitive vbCr vbCrLf vbLf

Operators

Operators for calculating, comparision, logical operators and other Operators.

! $ & ' ( ) * + - . / : <= <> = = == === >= And AndAlso Flip Mod Not Or OrElse Shl Shr Xor \ ^

Operator Order

Normally, an expression is executed from left to right following standard mathematical rules. Here is the overview about operator order (priority) from top to bottom, which means * is executed before And:

1. . ! ( )
2. Not Flip (unary +) (unary -)
3. * / \ Mod
4. & + -
5. ^
6. Shl Shr
7. < > < = >= = == ===
8. And
9. Or Xor
10. AndAlso
11. OrElse

Use paranthesis () to change the order.

Sub-Classing

Most built-in Java/Android classes may be used to create new classes (a sub-class) based on an existing Java/Android class. Change the file extension of a code file in order to do so.

Example: file name is 'Car.Object'.

Class name is 'Car' and super class is 'Object' (the file extension).

Control Flow & Structure

Decisions: The term 'decisions' refers to the use of conditional statements to decide what to execute in your program. Conditional statements test if a given expression is 'True' or 'False.'Then, statements are executed. Normally a condition uses an expression in which a comparison operator is used to compare two values or variables.

Loops: The statements that control decisions and loops are called control structures. Normally every command is executed only one time but in many cases it may be useful to run a command several times until a defined state has been reached. Loops repeat commands depending upon a condition. Some loops repeat commands while a condition is 'True,' other loops repeat commands while a condition is 'False.' There are other loops repeating a fixed number of times and some repeat for all elements of a collection.

Class : Classes are needed, when you would like use custom objects.

Module : Modules are needed, when you would like to organize large code parts

Do...Loop Until : repeats until a condition is set

Do...Loop While : repeats statements while condition is set

Do Until...Loop : A group of statements enabling you to define a loop which will be repeated until a certain condition remains true.

Do While...Loop : A group of statements enabling you to define a loop which will be repeated until a certain condition remains true.

Break : breaks out of a loop wether it is a for loop or not

Exit Do : breaks out of a loop

Exit For : breaks out of a for loop

Exit Function : exits a function

Exit Sub : exits a sub

For Next : Defines a loop that runs for a specified number of times.

GoTo : jumps to the desired label or line

If : single decision possibility

IIf : returns a value depending on an expression

Continue : continues to iterate a loop wether it is a for loop or not

Iterate Do : continues to iterate a loop if condition is set

Iterate For : continues to iterate a for loop if condition is set

Return : returns either from a gosub call or leaves the function or sub

Select : Multi-line conditional selection statement.

While...End While : A group of statements enabling you to define a loop which will be repeated until a certain condition remains true.

Comments

The comment symbol ' is used to mark comments in code. Comments can explain a procedure or a statement. DroidBasic ignores all comments while compiling and running your program. To write a comment, use the symbol ' followed by the text of the comment. Comments are printed in green on screen. Comments are extremely helpful when it comes to explaining your code to other programmers. So comments, normally, describe how your program works.

* ' Code is recognized as comment till the end of the current line.

Literals

Besides keywords, symbols, and names, a DroidBasic program contains literals. A literal is a number or string representing a value. There are different numerical literals.

Byte, Short, Integer, Long	-1, 2, -44, 4453
Single	21.32, 0.344, -435.235421.21
Double	212.23
String	Is simply text, but it must start with a " and end with a " so that DroidBasic can recognize it as string. Strings uses the same escape codes as Objective-C strings. Important escape codes are: \" = Double quotation mark, \\ = Backslash
Boolean	True, False

Appendix: Way of naming

When coding in DroidBasic, you declare and name elements, like procedures (functions and subs), variables, and constants and so on. All names must start with a letter; may contain letters, numbers, or the sign _ (periods and commas are forbidden); and must not contain reserved words. A reserved word is a part of DroidBasic and has a predefined meaning. These include keywords (e.g. If or Then), builtin-functions and operators (e.g. Mod). Be aware that names are case sensitive, which means you must it write with the same lowercase or uppercase letters everywhere.

Appendix: List of Java Keywords

The following list contains all Java keywords, which must not be used in DroidBasic code.

Appendix: Syntax of Arguments

The following list gives you some hints regarding how to read the syntax provided here.

Arguments listed inside brackets [ ] are optional.
(Do not write these [ ] in your code).

{ } together with | means that one of the elements must be written.
(Do not write these { } or | in your code).

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

Subs & Functions

Function Abs(Argument As Float) As Float

Abs(...) returns the absolute value of the given argument.

See also Atn

---

Function Activity() As Activity

Creates and returns a new object based on the class 'Activity'.

---

Sub Alert(Title As id [, Message As id])

Alert(...) shows a message on the screen. It is either is a small modal window with a title and a message or just a message only. Very useful for showing information to the user or to debug during application development. Close it by pressing the "back" button on your device.

Alias MsgBox

---

Function Append(Argument As String, Append As String) As String

Append(...) returns a new string as a combination of both given strings.

---

Function Asc(Argument As String [, Index As Integer]) As Integer

Asc(...) returns the unicode integer value of an character at the given position inside a string.

See also Chr
Alias Unicode

---

Function At(Argument As String, Index As Integer) As String

At(...) returns a single character from a given string as a string with the length 1 starting at the specified index argument.

---

Function Atn(Argument As Float) As Float

Atn(...) returns the principal arc tangent of x, in the interval [-pi/2,+pi/2] radians.

See also Atn

---

Function BitClr(Value As Integer, Position As Integer) As Integer

BitClr(...) lets you set a single bit of an integer value to 0.

---

Function BitSet(Value As Integer, Position As Integer) As Integer

BitSet(...) lets you set a single bit of an integer value to 1.

---

Function BitTst(Value As Integer, Position As Integer) As Integer

BitTst(...) lets you retrieve a single bit of an integer value.

---

Function Boolean(Expression As id, Locale As Boolean = False
| no arguments) As Boolean

Tries to convert an expression to a boolean. Locale is ignored for now.
Or creates and returns a new object of type 'Boolean'.

Alias CBool

---

Function Bundle() As Bundle

Creates and returns a new object based on the class 'Bundle'.

---

Function Button() As Button

Creates and returns a new object based on the class 'Button'.

---

Function CBool(Expression As id, Locale As Boolean = False) As Boolean

Tries to convert an expression to a boolean. Locale is ignored for now.

Alias Boolean

---

Function CByte(Expression As id, Locale As Boolean = False) As Integer

Tries to convert an expression to an integer type. This will remove any precision from a float value. Locale is ignored for now.

Alias CInt, CLng, CShort, Integer

---

Function CDbl(Expression As id, Locale As Boolean = False) As Float

Tries to convert an expression to a Float. Locale is ignored for now.

See also CSng, CInt, CLng
Alias CSng, Float

---

Function CInt(Expression As id, Locale As Boolean = False) As Integer

Tries to convert an expression to an integer type. This will remove any precision from a float value. Locale is ignored for now.

Alias CByte, CLng, CShort, Integer

---

Function CLng(Expression As id, Locale As Boolean = False) As Integer

Tries to convert an expression to an integer type. This will remove any precision from a float value. Locale is ignored for now.

Alias CByte, CInt, CShort, Integer

---

Function CShort(Expression As id, Locale As Boolean = False) As Integer

Tries to convert an expression to an integer type. This will remove any precision from a float value. Locale is ignored for now.

Alias CByte, CInt, CLng, Integer

---

Function CSng(Expression As id, Locale As Boolean = False) As Float

Tries to convert an expression to a Float. Locale is ignored for now.

See also CSng, CInt, CLng
Alias CDbl, Float

---

Function Character(Argument As Integer) As String

Character(...) returns a unicode character as string for a given integer unicode value. (Or returns the ASCII character corresponding to the value of Val. Argument must be a numerical expression.)

See also Asc
Alias Chr

---

Function CheckBox() As CheckBox

Creates and returns a new object based on the class 'CheckBox'.

---

Function Chr(Argument As Integer) As String

Chr(...) returns a unicode character as string for a given integer unicode value. (Or returns the ASCII character corresponding to the value of Val. Argument must be a numerical expression.)

See also Asc
Alias Character

---

Function ClassName(Expression As id) As String

---

Function Compare(Argument As String, Compare As String, CaseSensitive As Boolean = True) As Integer

Compare(...) lexically compares this string with the other string and returns an integer less than, equal to, or greater than zero if this string is less than, equal to, or greater than the other string.

---

Function CompoundButton() As CompoundButton

Creates and returns a new object based on the class 'CompoundButton'.

---

Function Contains(Argument As String, Search As String, CaseSensitive As Boolean = True) As Boolean

Contains(...) finds out if a given string is inside another string. Returns true if this Argument string contains an occurrence of the string Search; otherwise returns false.

---

Function Cos(Argument As Float) As Float

Cos(...) returns the cosine of the argument in radians.

---

Function Count(Argument As String, Search As String, CaseSensitive As Boolean = True) As Integer

Count(...) finds out how often a given string is inside another string.

---

Function Double() As Double

Creates and returns a new object of type 'Double'.

---

Function EndsWith(Argument As String, Search As String, CaseSensitive As Boolean = True) As Boolean

EndsWith(...) finds out if a given string ends with another string. Returns true if the string Argument ends with Search; otherwise returns false.

---

Function Exp(Argument As Float) As Float

Exp(...) returns the base-e exponential function of x, which is the e number raised to the power x.

See also Log10

---

Function Fact(Argument As Float) As Float

Fact(...) is implemented as follows:

---

Function FileExtension(Argument As String) As String

FileExtension(...) returns the name of the file extension of a given string, which is expected to contain a file name.

---

Function FileName(Argument As String) As String

FileName(...) is useful if you have to deal with filename in a string. It returns only the parts of the string, which are the name of the file name of a given string leaving out the full path.

---

Function FilePath(Argument As String) As String

FilePath(...) returns the path information of a given string, which is expected to contain a path with a file name.

---

Function Fix(Argument As Float) As Integer

Fix(...) removes the fraction part of a real number and returns the Integer portion only.

See also Int, CInt, CLng

---

Function Float(Expression As id, Locale As Boolean = False
| no arguments) As Float

Tries to convert an expression to a Float. Locale is ignored for now.
Or creates and returns a new object of type 'Float'.

See also CSng, CInt, CLng
Alias CDbl, CSng

---

Function Format(Argument As id, Locale As Boolean = False) As String

Format(...) returns a value as string formatted. The argument is usally a number. It is useful for formatting numbers. Locale is ignored for now.

---

Function FormatFloat(Argument As Float, Locale As Boolean = False, DecimalPlaceLength As Integer = 2) As String

Rounds decimal place (5 - 9 round up, else no round up). Locale and DecimalPlaceLength is ignored for now.

---

Function Hex(Argument As Integer) As String

Hex(...) returns a string representing a long value as hexadecimal.

---

Function InStr(Argument As String, Search As String, Index As Integer = 0, CaseSensitive As Boolean = True) As Integer

InStr(...) returns the position of the first occurrence of a given string inside another string starting from the beginning. It returns -1, if the string could not be found. First position in Source is referenced as 0.

Alias IndexOf

---

Function InStrRev(Argument As String, Search As String, Index As Integer = -1, CaseSensitive As Boolean = True) As Integer

InStrRev(...) returns the position of the first occurrence a given string inside another string starting from the end. It returns -1, if the string could not be found.

Alias LastIndexOf

---

Function IndexOf(Argument As String, Search As String, Index As Integer = 0, CaseSensitive As Boolean = True) As Integer

IndexOf(...) returns the position of the first occurrence of a given string inside another string starting from the beginning. It returns -1, if the string could not be found. First position in Source is referenced as 0.

Alias InStr

---

Function Int(Argument As Float) As Float

Int(...) returns the largest integer value that is not greater than the given argument (returns the next integer number <= given number).

See also Fix, CInt

---

Function Integer(Expression As id, Locale As Boolean = False
| no arguments) As Integer

Tries to convert an expression to an integer type. This will remove any precision from a float value. Locale is ignored for now.
Or creates and returns a new object of type 'Integer'.

Alias CByte, CInt, CLng, CShort

---

Function IsBoolean(Argument As id) As Boolean

Returns true if a variable represents a boolean type

---

Function IsByte(Argument As id) As Boolean

Returns true if a variable represents an integer (Byte, Short...) type.

Alias IsInt16, IsInt32, IsInt64, IsInt8, IsShort, IsInteger

---

Function IsDouble(Argument As id) As Boolean

Returns true if a variable represents a float type.

Alias IsSingle, IsFloat

---

Function IsEqualClass(Argument As id, 2ndArgument As id) As Boolean

Returns a Boolean '''value''' that indicates both objects are of the same class type.

See also IsEqualObject, IsEqualValue

---

Function IsEqualObject(Argument As id, 2ndArgument As id) As Boolean

Returns a Boolean '''value''' that indicates whether both objects are equal.

See also IsEqualClass, IsEqualValue

---

Function IsEqualValue(Argument As id, 2ndArgument As id) As Boolean

Returns a Boolean value that indicates whether both objects variables point to the same object.

See also IsEqualClass, IsEqualObject

---

Function IsFloat(Argument As id) As Boolean

Returns true if a variable represents a float type.

Alias IsDouble, IsSingle

---

Function IsInt16(Argument As id) As Boolean

Returns true if a variable represents an integer (Byte, Short...) type.

Alias IsByte, IsInt32, IsInt64, IsInt8, IsShort, IsInteger

---

Function IsInt32(Argument As id) As Boolean

Returns true if a variable represents an integer (Byte, Short...) type.

Alias IsByte, IsInt16, IsInt64, IsInt8, IsShort, IsInteger

---

Function IsInt64(Argument As id) As Boolean

Returns true if a variable represents an integer (Byte, Short...) type.

Alias IsByte, IsInt16, IsInt32, IsInt8, IsShort, IsInteger

---

Function IsInt8(Argument As id) As Boolean

Returns true if a variable represents an integer (Byte, Short...) type.

Alias IsByte, IsInt16, IsInt32, IsInt64, IsShort, IsInteger

---

Function IsInteger(Argument As id) As Boolean

Returns true if a variable represents an integer (Byte, Short...) type.

Alias IsByte, IsInt16, IsInt32, IsInt64, IsInt8, IsShort

---

Function IsShort(Argument As id) As Boolean

Returns true if a variable represents an integer (Byte, Short...) type.

Alias IsByte, IsInt16, IsInt32, IsInt64, IsInt8, IsInteger

---

Function IsSingle(Argument As id) As Boolean

Returns true if a variable represents a float type.

Alias IsDouble, IsFloat

---

Function IsString(Argument As id) As Boolean

Returns true if expression represents a string value.

---

Function LCase(Argument As String) As String

LCase(...) changes all characters of a string to lowercase. It then returns a copy of the string.

See also UCase
Alias Lower

---

Function LastIndexOf(Argument As String, Search As String, Index As Integer = -1, CaseSensitive As Boolean = True) As Integer

LastIndexOf(...) returns the position of the first occurrence a given string inside another string starting from the end. It returns -1, if the string could not be found.

Alias InStrRev

---

Function Left(Argument As String, Position As Integer) As String

Left(...) returns the leftmost part of a string containing 'Position' number of characters.

See also Right, Mid

---

Function Len(Argument As String) As Integer

Len(...) returns the length of a string.

Alias Length

---

Function Length(Argument As String) As Integer

Length(...) returns the length of a string.

Alias Len

---

Function Ln(Argument As Float) As Float

Ln(...) returns the natural logarithm of the given argument. The Ln function calculates the base 'e' (or natural) logaritm of a number. Input number must be a positive (i.e. > 0).

See also Log10

---

Function Log10(Argument As Float) As Float

Log10(...) returns the common (base-10) logarithm of the given argument (calculates the ten-based logarithmic of a number). Input number must be a positive (i.e. > 0).

See also Ln

---

Function Long() As Long

Creates and returns a new object of type 'Long'.

---

Function Lower(Argument As String) As String

Lower(...) changes all characters of a string to lowercase. It then returns a copy of the string.

See also UCase
Alias LCase

---

Function Max(Value1 As Float, Value2 As Float) As Float

Max(...) compares two values and returns the bigger one. Both values are treated as Float values.

See also Min

---

Function Min(Value1 As Float, Value2 As Float) As Float

Min(...) compares two values and returns the smaller one. Both values are treated as Float values.

See also Max

---

Sub MsgBox(Title As id [, Message As id])

MsgBox(...) shows a message on the screen. It is either is a small modal window with a title and a message or just a message only. Very useful for showing information to the user or to debug during application development. Close it by pressing the "back" button on your device.

Alias Alert

---

Function Nz(Argument As id, ReturnValue As id = "") As String

Nz(...) checks for null and returns an empty string (nullstring), if needed.

---

Function Object(
| no arguments) As Object

Creates and returns a new object based on the class 'Object'.
Or creates and returns a new object of type 'Object'.

---

Function Prepend(Argument As String, Prepend As String) As String

Prepend(...) returns a new string as a combination of both given strings.

---

Function QStringList(Expression As id, Locale As Boolean = False) As QStringList

---

Function RND([Argument As Float]) As Float

RND(...) returns a float pseudo-random number. If an argument is given random values between 0 and the argument are returned only. If no argument is given, the next random number in the list is created and returned. If you use RND(...) the first time and you have not called Randomize() before, it is automatically called and new random numbers are created.

Alias Random

---

Function RadioButton() As RadioButton

Creates and returns a new object based on the class 'RadioButton'.

---

Function Random([Argument As Float]) As Float

Random(...) returns a float pseudo-random number. If an argument is given random values between 0 and the argument are returned only. If no argument is given, the next random number in the list is created and returned. If you use Random(...) the first time and you have not called Randomize() before, it is automatically called and new random numbers are created.

Alias RND

---

Sub Randomize()

Randomize() restarts the internal random number generator based on the current local system time. Using it only makes sense, if you want to use the Random() function as well.

See also Random

---

Function ReadArray(FilePathOrURL As String) As Array

ReadArray(...) loads an entire file from a path or on a website into a Array. You may even read html webpages with this function.

---

Function ReadDictionary(FilePathOrURL As String) As Dictionary

ReadDictionary(...) loads an entire file from a path or on a website into a Dictionary. You may even read html webpages with this function.

---

Function ReadObject(FilePathOrURL As String) As id

ReadObject(...) loads an entire file from a path or on a website into an object. NOT IMPLEMENTED YET.

---

Function Replace(Argument As String, Search As String, Replace As String, CaseSensitive As Boolean = True) As String

Replace(...) changes all occurrences of a string inside another string to a new string.

---

Function Reversed(Argument As String) As String

Reversed(...) returns a given string reversed.

---

Function Right(Argument As String, Position As Integer) As String

Right(...) returns the rightmost part of a string beginning at 'Position' (returns a string containing the last characters of a string).

---

Function Round(Argument As Float, Precision As Integer) As Float

Round(...) rounds a value, while Precision determines the number of digits after the decimal point.

---

Function Sin(Argument As Float) As Float

Sin(...) returns the sine of the argument 'number' in radians.

---

Function Single() As Single

Creates and returns a new object of type 'Single'.

---

Function Space(Count As Integer, FillWith As String = " ") As String

Space(...) function creates a string consisting of spaces (or other characters) based on x length.

---

Function Sqr(Argument As Float) As Float

Sqr(...) returns the square root of the argument 'number'.

See also Fix, CInt

---

Function StartsWith(Argument As String, Search As String, CaseSensitive As Boolean = True) As Boolean

StartsWith(...) finds out if a given string starts with another string.

---

Function Str(Expression As id, Locale As Boolean = False) As String

Converts a number to a string. Locale is ignored for now.

Alias String

---

Function StrReverse(Argument As String) As String

StrReverse(...) returns a all parts of a string mirrored.

---

Function String(Expression As id, Locale As Boolean = False
| no arguments) As String

Converts a number to a string. Locale is ignored for now.
Or creates and returns a new object of type 'String'.

Alias Str

---

Function Tan(Argument As Float) As Float

Tan(...) returns the tangent of the argument 'number' in radians.

---

Function TextView() As TextView

Creates and returns a new object based on the class 'TextView'.

---

Function Trim(Argument As String) As String

Trim(...) returns a string, in which all whitespace characters at the beginning and end have been removed (removes the source string's leading and trailing spaces and other non-printable characters).

See also LTrim, RTrim
Alias Trimmed

---

Function Trimmed(Argument As String) As String

Trimmed(...) returns a string, in which all whitespace characters at the beginning and end have been removed (removes the source string's leading and trailing spaces and other non-printable characters).

See also LTrim, RTrim
Alias Trim

---

Function UCase(Argument As String) As String

UCase(...) changes all characters of a string to uppercase (contains the source string converted to all upper case).

See also UCase
Alias Upper

---

Function Unicode(Argument As String [, Index As Integer]) As Integer

Unicode(...) returns the unicode integer value of an character at the given position inside a string.

See also Chr
Alias Asc

---

Function Upper(Argument As String) As String

Upper(...) changes all characters of a string to uppercase (contains the source string converted to all upper case).

See also UCase
Alias UCase

---

Function View() As View

Creates and returns a new object based on the class 'View'.

---

Function WriteArray(Argument As Array, FilePathOrURL As String) As Boolean

WriteArray(...) saves the entire Array in a file to a given path.

---

Function WriteDictionary(Argument As Dictionary, FilePathOrURL As String) As Boolean

WriteDictionary(...) saves the entire Dictionary in a file to a given path.

---

Function WriteObject(Argument As id, FilePathOrURL As String) As Boolean

WriteObject(...) saves the entire object in a file to a given path. NOT IMPLEMENTED YET.

---

Function id() As id

Creates and returns a new object of type 'id'.

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

Objects

Object SystemClock

Subs & Functions

Function currentThreadTimeMillis() As Long

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

Classes

Class Activity

Events

Event onCreate(savedInstanceState As Bundle)

Event onDestroy()

Event onPause()

Event onResume()

Event onStart()

Event onStop()

---

Class Bundle

---

Class Button

Events

Event onInitializeAccessibilityEvent(event As AccessibilityEvent)

Initializes an android.view.accessibility.AccessibilityEvent with information about this View which is the event source.

Event onInitializeAccessibilityNodeInfo(info As AccessibilityNodeInfo)

Initializes an android.view.accessibility.AccessibilityNodeInfo with information about this view.

---

Class CheckBox

Events

Event onInitializeAccessibilityEvent(event As AccessibilityEvent)

Initializes an android.view.accessibility.AccessibilityEvent with information about this View which is the event source.

Event onInitializeAccessibilityNodeInfo(info As AccessibilityNodeInfo)

Initializes an android.view.accessibility.AccessibilityNodeInfo with information about this view.

---

Class CompoundButton

Subs & Functions

Function isChecked() As Boolean

Sub jumpDrawablesToCurrentState()

Call Drawable.jumpToCurrentState() on all Drawable objects associated with this view.

Function performClick() As boolean

Call this view's OnClickListener, if it is defined.

Sub setButtonDrawable(resid As Integer)

Set the background to a given Drawable, identified by its resource id.

Sub setButtonDrawable2(d As Drawable)

Set the background to a given Drawable

Sub setChecked(checked As Boolean)

Changes the checked state of this button.

Sub setOnCheckedChangeListener(listener As OnCheckedChangeListener)

Register a callback to be invoked when the checked state of this button changes.

Sub toggle()

Change the checked state of the view to the inverse of its current state

Events

Event onInitializeAccessibilityEvent(event As AccessibilityEvent)

Initializes an android.view.accessibility.AccessibilityEvent with information about this View which is the event source.

Event onInitializeAccessibilityNodeInfo(info As AccessibilityNodeInfo)

Initializes an android.view.accessibility.AccessibilityNodeInfo with information about this view.

Event onRestoreInstanceState(state As Parcelable)

Hook allowing a view to re-apply a representation of its internal state that had previously been generated by onSaveInstanceState().

Event onSaveInstanceState() As Parcelable

Hook allowing a view to generate a representation of its internal state that can later be used to create a new instance with that same state.

---

Class Object

Subs & Functions

Function toString() As String

Events

Event Finalize()

Event Init()

---

Class RadioButton

Subs & Functions

Sub toggle()

Change the checked state of the view to the inverse of its current state

Events

Event onInitializeAccessibilityEvent(event As AccessibilityEvent)

Initializes an android.view.accessibility.AccessibilityEvent with information about this View which is the event source.

Event onInitializeAccessibilityNodeInfo(info As AccessibilityNodeInfo)

Initializes an android.view.accessibility.AccessibilityNodeInfo with information about this view.

---

Class TextView

Subs & Functions

Sub addTextChangedListener(watcher As TextWatcher)

Adds a TextWatcher to the list of those whose methods are called whenever this TextView's text changes.

Sub append(text As CharSequence)

Convenience method: Append the specified text to the TextView's display buffer, upgrading it to BufferType.EDITABLE if it was not already editable.

Sub append2(text As CharSequence, start As Integer, end As Integer)

Convenience method: Append the specified text slice to the TextView's display buffer, upgrading it to BufferType.EDITABLE if it was not already editable.

Sub beginBatchEdit()

Function bringPointIntoView(offset As Integer) As Boolean

Move the point, specified by the offset, into the view if it is needed.

Sub cancelLongPress()

Cancels a pending long press.

Sub clearComposingText()

Use BaseInputConnection.removeComposingSpans() to remove any IME composing state from this text view.

Sub computeScroll()

Called by a parent to request that a child update its values for mScrollX and mScrollY if necessary.

Sub debug(depth As Integer)

Prints information about this view in the log output, with the tag VIEW_LOG_TAG.

Function didTouchFocusSelect() As Boolean

Returns true, only while processing a touch gesture, if the initial touch down event caused focus to move to the text view and as a result its selection changed.

Sub endBatchEdit()

Function extractText(request As ExtractedTextRequest, outText As ExtractedText) As Boolean

If this TextView contains editable content, extract a portion of it based on the information in request in to outText.

Sub findViewsWithText(outViews As ArrayList<View>, searched As CharSequence, flags As Integer)

Finds the Views that contain given text.

Function getAutoLinkMask() As Integer

Gets the autolink mask of the text.

Function getBaseline() As Integer

Return the offset of the widget's text baseline from the widget's top boundary.

Function getCompoundDrawablePadding() As Integer

Returns the padding between the compound drawables and the text.

Function getCompoundDrawables() As Drawable[]

Returns drawables for the left, top, right, and bottom borders.

Function getCompoundPaddingBottom() As Integer

Returns the bottom padding of the view, plus space for the bottom Drawable if any.

Function getCompoundPaddingLeft() As Integer

Returns the left padding of the view, plus space for the left Drawable if any.

Function getCompoundPaddingRight() As Integer

Returns the right padding of the view, plus space for the right Drawable if any.

Function getCompoundPaddingTop() As Integer

Returns the top padding of the view, plus space for the top Drawable if any.

Function getCurrentHintTextColor() As Integer

Return the current color selected to paint the hint text.

Function getCurrentTextColor() As Integer

Return the current color selected for normal text.

Function getCustomSelectionActionModeCallback() As Callback

Retrieves the value set in setCustomSelectionActionModeCallback(ActionMode.Callback).

Function getEditableText() As Editable

Return the text the TextView is displaying as an Editable object.

Function getEllipsize() As TruncateAt

Returns where, if anywhere, words that are longer than the view is wide should be ellipsized.

Function getError() As CharSequence

Returns the error message that was set to be displayed with setError(CharSequence), or null if no error was set or if it the error was cleared by the widget after user input.

Function getExtendedPaddingBottom() As Integer

Returns the extended bottom padding of the view, including both the bottom Drawable if any and any extra space to keep more than maxLines of text from showing.

Function getExtendedPaddingTop() As Integer

Returns the extended top padding of the view, including both the top Drawable if any and any extra space to keep more than maxLines of text from showing.

Function getFilters() As InputFilter[]

Returns the current list of input filters.

Sub getFocusedRect(r As Rect)

When a view has focus and the user navigates away from it, the next view is searched for starting from the rectangle filled in by this method.

Function getFreezesText() As Boolean

Return whether this text view is including its entire text contents in frozen icicles.

Function getGravity() As Integer

Returns the horizontal and vertical alignment of this TextView.

Function getHighlightColor() As Integer

Function getHint() As CharSequence

Returns the hint that is displayed when the text of the TextView is empty.

Function getHintTextColors() As ColorStateList

Function getImeActionId() As Integer

Get the IME action ID previous set with setImeActionLabel(CharSequence, int).

Function getImeActionLabel() As CharSequence

Get the IME action label previous set with setImeActionLabel(CharSequence, int).

Function getImeOptions() As Integer

Get the type of the IME editor.

Function getIncludeFontPadding() As Boolean

Gets whether the TextView includes extra top and bottom padding to make room for accents that go above the normal ascent and descent.

Function getInputExtras(create As Boolean) As Bundle

Retrieve the input extras currently associated with the text view, which can be viewed as well as modified.

Function getInputType() As Integer

Get the type of the editable content.

Function getKeyListener() As KeyListener

Function getLayout() As Layout

Function getLineBounds(line As Integer, bounds As Rect) As Integer

Return the baseline for the specified line (0...getLineCount() - 1) If bounds is not null, return the top, left, right, bottom extents of the specified line in it.

Function getLineCount() As Integer

Return the number of lines of text, or 0 if the internal Layout has not been built.

Function getLineHeight() As Integer

Function getLineSpacingExtra() As Single

Gets the line spacing extra space

Function getLineSpacingMultiplier() As Single

Gets the line spacing multiplier

Function getLinkTextColors() As ColorStateList

Function getLinksClickable() As Boolean

Returns whether the movement method will automatically be set to android.text.method.LinkMovementMethod if setAutoLinkMask(int) has been set to nonzero and links are detected in setText(char[], int, int).

Function getMarqueeRepeatLimit() As Integer

Gets the number of times the marquee animation is repeated.

Function getMaxEms() As Integer

Function getMaxHeight() As Integer

Function getMaxLines() As Integer

Function getMaxWidth() As Integer

Function getMinEms() As Integer

Function getMinHeight() As Integer

Function getMinLines() As Integer

Function getMinWidth() As Integer

Function getMovementMethod() As MovementMethod

Function getOffsetForPosition(x As Single, y As Single) As Integer

Get the character offset closest to the specified absolute position.

Function getPaint() As TextPaint

Function getPaintFlags() As Integer

Function getPrivateImeOptions() As String

Get the private type of the content.

Function getSelectionEnd() As Integer

Convenience for getSelectionEnd(CharSequence).

Function getSelectionStart() As Integer

Convenience for getSelectionStart(CharSequence).

Function getShadowColor() As Integer

Function getShadowDx() As Single

Function getShadowDy() As Single

Function getShadowRadius() As Single

Gets the radius of the shadow layer.

Function getText() As CharSequence

Return the text the TextView is displaying.

Function getTextColor(context As Context, attrs As TypedArray, def As Integer) As Integer

Returns the default color from the TextView_textColor attribute from the AttributeSet, if set, or the default color from the TextAppearance_textColor from the TextView_textAppearance attribute, if TextView_textColor was not set directly.

Function getTextColors() As ColorStateList

Gets the text colors for the different states (normal, selected, focused) of the TextView.

Function getTextColors2(context As Context, attrs As TypedArray) As ColorStateList

Returns the TextView_textColor attribute from the Resources.StyledAttributes, if set, or the TextAppearance_textColor from the TextView_textAppearance attribute, if TextView_textColor was not set directly.

Function getTextScaleX() As Single

Function getTextSize() As Single

Function getTotalPaddingBottom() As Integer

Returns the total bottom padding of the view, including the bottom Drawable if any, the extra space to keep more than maxLines from showing, and the vertical offset for gravity, if any.

Function getTotalPaddingLeft() As Integer

Returns the total left padding of the view, including the left Drawable if any.

Function getTotalPaddingRight() As Integer

Returns the total right padding of the view, including the right Drawable if any.

Function getTotalPaddingTop() As Integer

Returns the total top padding of the view, including the top Drawable if any, the extra space to keep more than maxLines from showing, and the vertical offset for gravity, if any.

Function getTransformationMethod() As TransformationMethod

Function getTypeface() As Typeface

Function getUrls() As URLSpan[]

Returns the list of URLSpans attached to the text (by android.text.util.Linkify or otherwise) if any.

Function hasOverlappingRendering() As Boolean

Returns whether this View has content which overlaps.

Function hasSelection() As Boolean

Return true iff there is a selection inside this text view.

Sub invalidateDrawable(drawable As Drawable)

Invalidates the specified Drawable.

Function isCursorVisible() As Boolean

Function isInputMethodTarget() As Boolean

Returns whether this text view is a current input method target.

Function isSuggestionsEnabled() As Boolean

Return whether or not suggestions are enabled on this TextView.

Function isTextSelectable() As Boolean

When a TextView is used to display a useful piece of information to the user (such as a contact's address), it should be made selectable, so that the user can select and copy this content.

Sub jumpDrawablesToCurrentState()

Call Drawable.jumpToCurrentState() on all Drawable objects associated with this view.

Function length() As Integer

Returns the length, in characters, of the text managed by this TextView

Function moveCursorToVisibleOffset() As Boolean

Move the cursor, if needed, so that it is at an offset that is visible to the user.

Function performLongClick() As Boolean

Call this view's OnLongClickListener, if it is defined.

Sub removeTextChangedListener(watcher As TextWatcher)

Removes the specified TextWatcher from the list of those whose methods are called whenever this TextView's text changes.

Sub sendAccessibilityEvent(eventType As Integer)

Sends an accessibility event of the given type.

Sub setAllCaps(allCaps As Boolean)

Sets the properties of this field to transform input to ALL CAPS display.

Sub setAutoLinkMask(mask As Integer)

Sets the autolink mask of the text.

Sub setCompoundDrawablePadding(pad As Integer)

Sets the size of the padding between the compound drawables and the text.

Sub setCompoundDrawables(left As Drawable, top As Drawable, right As Drawable, bottom As Drawable)

Sets the Drawables (if any) to appear to the left of, above, to the right of, and below the text.

Sub setCompoundDrawablesWithIntrinsicBounds(left As Drawable, top As Drawable, right As Drawable, bottom As Drawable)

Sets the Drawables (if any) to appear to the left of, above, to the right of, and below the text.

Sub setCompoundDrawablesWithIntrinsicBounds2(left As Integer, top As Integer, right As Integer, bottom As Integer)

Sets the Drawables (if any) to appear to the left of, above, to the right of, and below the text.

Sub setCursorVisible(visible As Boolean)

Set whether the cursor is visible.

Sub setCustomSelectionActionModeCallback(actionModeCallback As Callback)

If provided, this ActionMode.Callback will be used to create the ActionMode when text selection is initiated in this View.

Sub setEditableFactory(factory As Factory)

Sets the Factory used to create new Editables.

Sub setEllipsize(where As TruncateAt)

Causes words in the text that are longer than the view is wide to be ellipsized instead of broken in the middle.

Sub setEms(ems As Integer)

Makes the TextView exactly this many ems wide

Sub setEnabled(enabled As Boolean)

Set the enabled state of this view.

Sub setError(error As CharSequence)

Sets the right-hand compound drawable of the TextView to the "error" icon and sets an error message that will be displayed in a popup when the TextView has focus.

Sub setError2(error As CharSequence, icon As Drawable)

Sets the right-hand compound drawable of the TextView to the specified icon and sets an error message that will be displayed in a popup when the TextView has focus.

Sub setExtractedText(text As ExtractedText)

Apply to this text view the given extracted text, as previously returned by extractText(ExtractedTextRequest, ExtractedText).

Sub setFilters(filters As android.text.InputFilter[])

Sets the list of input filters that will be used if the buffer is Editable.

Sub setFreezesText(freezesText As Boolean)

Control whether this text view saves its entire text contents when freezing to an icicle, in addition to dynamic state such as cursor position.

Sub setGravity(gravity As Integer)

Sets the horizontal alignment of the text and the vertical gravity that will be used when there is extra space in the TextView beyond what is required for the text itself.

Sub setHeight(pixels As Integer)

Makes the TextView exactly this many pixels tall.

Sub setHighlightColor(color As Integer)

Sets the color used to display the selection highlight.

Sub setHint(hint As CharSequence)

Sets the text to be displayed when the text of the TextView is empty.

Sub setHint2(resid As Integer)

Sets the text to be displayed when the text of the TextView is empty, from a resource.

Sub setHintTextColor(colors As ColorStateList)

Sets the color of the hint text.

Sub setHintTextColor2(color As Integer)

Sets the color of the hint text for all the states (disabled, focussed, selected...) of this TextView.

Sub setHorizontallyScrolling(whether As Boolean)

Sets whether the text should be allowed to be wider than the View is.

Sub setImeActionLabel(label As CharSequence, actionId As Integer)

Change the custom IME action associated with the text view, which will be reported to an IME with actionLabel and actionId when it has focus.

Sub setImeOptions(imeOptions As Integer)

Change the editor type integer associated with the text view, which will be reported to an IME with imeOptions when it has focus.

Sub setIncludeFontPadding(includepad As Boolean)

Set whether the TextView includes extra top and bottom padding to make room for accents that go above the normal ascent and descent.

Sub setInputExtras(xmlResId As Integer)

Set the extra input data of the text, which is the TextBoxAttribute.extras Bundle that will be filled in when creating an input connection.

Sub setInputType(type As Integer)

Set the type of the content with a constant as defined for inputType.

Sub setKeyListener(input As KeyListener)

Sets the key listener to be used with this TextView.

Sub setLineSpacing(add As Single, mult As Single)

Sets line spacing for this TextView.

Sub setLines(lines As Integer)

Makes the TextView exactly this many lines tall.

Sub setLinkTextColor(colors As ColorStateList)

Sets the color of links in the text.

Sub setLinkTextColor2(color As Integer)

Sets the color of links in the text.

Sub setLinksClickable(whether As Boolean)

Sets whether the movement method will automatically be set to android.text.method.LinkMovementMethod if setAutoLinkMask(int) has been set to nonzero and links are detected in setText(char[], int, int).

Sub setMarqueeRepeatLimit(marqueeLimit As Integer)

Sets how many times to repeat the marquee animation.

Sub setMaxEms(maxems As Integer)

Makes the TextView at most this many ems wide

Sub setMaxHeight(maxHeight As Integer)

Makes the TextView at most this many pixels tall.

Sub setMaxLines(maxlines As Integer)

Makes the TextView at most this many lines tall.

Sub setMaxWidth(maxpixels As Integer)

Makes the TextView at most this many pixels wide

Sub setMinEms(minems As Integer)

Makes the TextView at least this many ems wide

Sub setMinHeight(minHeight As Integer)

Makes the TextView at least this many pixels tall.

Sub setMinLines(minlines As Integer)

Makes the TextView at least this many lines tall.

Sub setMinWidth(minpixels As Integer)

Makes the TextView at least this many pixels wide

Sub setMovementMethod(movement As MovementMethod)

Sets the movement method (arrow key handler) to be used for this TextView.

Sub setOnEditorActionListener(l As OnEditorActionListener)

Set a special listener to be called when an action is performed on the text view.

Sub setPadding(left As Integer, top As Integer, right As Integer, bottom As Integer)

Sets the padding.

Sub setPaddingRelative(start As Integer, top As Integer, end As Integer, bottom As Integer)

Sets the relative padding.

Sub setPaintFlags(flags As Integer)

Sets flags on the Paint being used to display the text and reflows the text if they are different from the old flags.

Sub setPrivateImeOptions(type As String)

Set the private content type of the text, which is the EditorInfo.privateImeOptions field that will be filled in when creating an input connection.

Sub setRawInputType(type As Integer)

Directly change the content type integer of the text view, without modifying any other state.

Sub setScroller(s As Scroller)

Sub setSelectAllOnFocus(selectAllOnFocus As Boolean)

Set the TextView so that when it takes focus, all the text is selected.

Sub setSelected(selected As Boolean)

Changes the selection state of this view.

Sub setShadowLayer(radius As Single, dx As Single, dy As Single, color As Integer)

Gives the text a shadow of the specified radius and color, the specified distance from its normal position.

Sub setSingleLine()

Sets the properties of this field (lines, horizontally scrolling, transformation method) to be for a single-line input.

Sub setSingleLine2(singleLine As Boolean)

If true, sets the properties of this field (number of lines, horizontally scrolling, transformation method) to be for a single-line input; if false, restores these to the default conditions.

Sub setSpannableFactory(factory As Factory)

Sets the Factory used to create new Spannables.

Sub setText(resid As Integer)

Sub setText2(text As char[], start As Integer, len As Integer)

Sets the TextView to display the specified slice of the specified char array.

Sub setText3(resid As Integer, type As BufferType)

Sub setText4(text As CharSequence)

Sets the string value of the TextView.

Sub setText5(text As CharSequence, type As BufferType)

Sets the text that this TextView is to display (see setText(CharSequence)) and also sets whether it is stored in a styleable/spannable buffer and whether it is editable.

Sub setTextAppearance(context As Context, resid As Integer)

Sets the text color, size, style, hint color, and highlight color from the specified TextAppearance resource.

Sub setTextColor(colors As ColorStateList)

Sets the text color.

Sub setTextColor2(color As Integer)

Sets the text color for all the states (normal, selected, focused) to be this color.

Sub setTextIsSelectable(selectable As Boolean)

Sets whether or not (default) the content of this view is selectable by the user.

Sub setTextKeepState(text As CharSequence)

Like setText(CharSequence), except that the cursor position (if any) is retained in the new text.

Sub setTextKeepState2(text As CharSequence, type As BufferType)

Like setText(CharSequence, android.widget.TextView.BufferType), except that the cursor position (if any) is retained in the new text.

Sub setTextScaleX(size As Single)

Sets the extent by which text should be stretched horizontally.

Sub setTextSize(size As Single)

Set the default text size to the given value, interpreted as "scaled pixel" units.

Sub setTextSize2(unit As Integer, size As Single)

Set the default text size to a given unit and value.

Sub setTransformationMethod(method As TransformationMethod)

Sets the transformation that is applied to the text that this TextView is displaying.

Sub setTypeface(tf As Typeface, style As Integer)

Sets the typeface and style in which the text should be displayed, and turns on the fake bold and italic bits in the Paint if the Typeface that you provided does not have all the bits in the style that you specified.

Sub setTypeface2(tf As Typeface)

Sets the typeface and style in which the text should be displayed.

Sub setWidth(pixels As Integer)

Makes the TextView exactly this many pixels wide.

Events

Event onBeginBatchEdit()

Called by the framework in response to a request to begin a batch of edit operations through a call to link beginBatchEdit().

Event onCheckIsTextEditor() As Boolean

Check whether the called view is a text editor, in which case it would make sense to automatically display a soft input window for it.

Event onCommitCompletion(text As CompletionInfo)

Called by the framework in response to a text completion from the current input method, provided by it calling InputConnection.commitCompletion().

Event onCommitCorrection(info As CorrectionInfo)

Called by the framework in response to a text auto-correction (such as fixing a typo using a a dictionnary) from the current input method, provided by it calling commitCorrection(CorrectionInfo) InputConnection.commitCorrection()}.

Event onCreateInputConnection(outAttrs As EditorInfo) As InputConnection

Create a new InputConnection for an InputMethod to interact with the view.

Event onDragEvent(event As DragEvent) As Boolean

Handles drag events sent by the system following a call to startDrag().

Event onEditorAction(actionCode As Integer)

Called when an attached input method calls InputConnection.performEditorAction() for this text view.

Event onEndBatchEdit()

Called by the framework in response to a request to end a batch of edit operations through a call to link endBatchEdit().

Event onFinishTemporaryDetach()

Called after onStartTemporaryDetach() when the container is done changing the view.

Event onGenericMotionEvent(event As MotionEvent) As Boolean

Implement this method to handle generic motion events.

Event onInitializeAccessibilityEvent(event As AccessibilityEvent)

Initializes an android.view.accessibility.AccessibilityEvent with information about this View which is the event source.

Event onInitializeAccessibilityNodeInfo(info As AccessibilityNodeInfo)

Initializes an android.view.accessibility.AccessibilityNodeInfo with information about this view.

Event onKeyDown(keyCode As Integer, event As KeyEvent) As Boolean

Default implementation of KeyEvent.Callback.onKeyDown(): perform press of the view when KEYCODE_DPAD_CENTER or KEYCODE_ENTER is released, if the view is enabled and clickable.

Event onKeyMultiple(keyCode As Integer, repeatCount As Integer, event As KeyEvent) As Boolean

Default implementation of KeyEvent.Callback.onKeyMultiple(): always returns false (doesn't handle the event).

Event onKeyPreIme(keyCode As Integer, event As KeyEvent) As Boolean

Handle a key event before it is processed by any input method associated with the view hierarchy.

Event onKeyShortcut(keyCode As Integer, event As KeyEvent) As Boolean

Called on the focused view when a key shortcut event is not handled.

Event onKeyUp(keyCode As Integer, event As KeyEvent) As Boolean

Default implementation of KeyEvent.Callback.onKeyUp(): perform clicking of the view when KEYCODE_DPAD_CENTER or KEYCODE_ENTER is released.

Event onPopulateAccessibilityEvent(event As AccessibilityEvent)

Called from dispatchPopulateAccessibilityEvent(AccessibilityEvent) giving a chance to this View to populate the accessibility event with its text content.

Event onPreDraw() As Boolean

Callback method to be invoked when the view tree is about to be drawn.

Event onPrivateIMECommand(action As String, data As Bundle) As Boolean

Called by the framework in response to a private command from the current method, provided by it calling InputConnection.performPrivateCommand().

Event onRestoreInstanceState(state As Parcelable)

Hook allowing a view to re-apply a representation of its internal state that had previously been generated by onSaveInstanceState().

Event onSaveInstanceState() As Parcelable

Hook allowing a view to generate a representation of its internal state that can later be used to create a new instance with that same state.

Event onScreenStateChanged(screenState As Integer)

This method is called whenever the state of the screen this view is attached to changes.

Event onStartTemporaryDetach()

This is called when a container is going to temporarily detach a child, with ViewGroup.detachViewFromParent.

Event onTextContextMenuItem(id As Integer) As Boolean

Called when a context menu option for the text view is selected.

Event onTouchEvent(event As MotionEvent) As Boolean

Implement this method to handle touch screen motion events.

Event onTrackballEvent(event As MotionEvent) As Boolean

Implement this method to handle trackball motion events.

Event onWindowFocusChanged(hasWindowFocus As Boolean)

Called when the window containing this view gains or loses focus.

---

Class View

Constants

Const DRAWING_CACHE_QUALITY_AUTO As Integer

Enables automatic quality mode for the drawing cache.

Const DRAWING_CACHE_QUALITY_HIGH As Integer

Enables high quality mode for the drawing cache.

Const DRAWING_CACHE_QUALITY_LOW As Integer

Enables low quality mode for the drawing cache.

Const FIND_VIEWS_WITH_CONTENT_DESCRIPTION As Integer

Find find views that contain the specified content description.

Const FIND_VIEWS_WITH_TEXT As Integer

Find views that render the specified text.

Const FOCUSABLES_ALL As Integer

View flag indicating whether addFocusables(ArrayList, int, int)should add all focusable Views regardless if they are focusable in touch mode.

Const FOCUSABLES_TOUCH_MODE As Integer

View flag indicating whether addFocusables(ArrayList, int, int)should add only Views focusable in touch mode.

Const FOCUS_BACKWARD As Integer

Use with focusSearch(int).

Const FOCUS_DOWN As Integer

Use with focusSearch(int).

Const FOCUS_FORWARD As Integer

Use with focusSearch(int).

Const FOCUS_LEFT As Integer

Use with focusSearch(int).

Const FOCUS_RIGHT As Integer

Use with focusSearch(int).

Const FOCUS_UP As Integer

Use with focusSearch(int).

Const GONE As Integer

This view is invisible, and it doesn't take any space for layoutpurposes.

Const HAPTIC_FEEDBACK_ENABLED As Integer

View flag indicating whether this view should have haptic feedbackenabled for events such as long presses.

Const IMPORTANT_FOR_ACCESSIBILITY_AUTO As Integer

Automatically determine whether a view is important for accessibility.

Const IMPORTANT_FOR_ACCESSIBILITY_NO As Integer

The view is not important for accessibility.

Const IMPORTANT_FOR_ACCESSIBILITY_YES As Integer

The view is important for accessibility.

Const INVISIBLE As Integer

This view is invisible, but it still takes up space for layout purposes.

Const KEEP_SCREEN_ON As Integer

View flag indicating that the screen should remain on while thewindow containing this view is visible to the user.

Const LAYER_TYPE_HARDWARE As Integer

Indicates that the view has a hardware layer.

Const LAYER_TYPE_NONE As Integer

Indicates that the view does not have a layer.

Const LAYER_TYPE_SOFTWARE As Integer

Indicates that the view has a software layer.

Const MEASURED_HEIGHT_STATE_SHIFT As Integer

Bit shift of MEASURED_STATE_MASK to get to the height bitsfor functions that combine both width and height into a single int,such as getMeasuredState() and the childState argument ofresolveSizeAndState(int, int, int).

Const MEASURED_SIZE_MASK As Integer

Bits of getMeasuredWidthAndState() andgetMeasuredWidthAndState() that provide the actual measured size.

Const MEASURED_STATE_MASK As Integer

Bits of getMeasuredWidthAndState() andgetMeasuredWidthAndState() that provide the additional state bits.

Const MEASURED_STATE_TOO_SMALL As Integer

Bit of getMeasuredWidthAndState() andgetMeasuredWidthAndState() that indicates the measured sizeis smaller that the space the view would like to have.

Const NO_ID As Integer

Used to mark a View that has no ID.

Const OVER_SCROLL_ALWAYS As Integer

Always allow a user to over-scroll this view, provided it is aview that can scroll.

Const OVER_SCROLL_IF_CONTENT_SCROLLS As Integer

Allow a user to over-scroll this view only if the content is largeenough to meaningfully scroll, provided it is a view that can scroll.

Const OVER_SCROLL_NEVER As Integer

Never allow a user to over-scroll this view.

Const SCREEN_STATE_OFF As Integer

Indicates that the screen has changed state and is now off.

Const SCREEN_STATE_ON As Integer

Indicates that the screen has changed state and is now on.

Const SCROLLBARS_INSIDE_INSET As Integer

The scrollbar style to display the scrollbars inside the padded area,increasing the padding of the view.

Const SCROLLBARS_INSIDE_OVERLAY As Integer

The scrollbar style to display the scrollbars inside the content area,without increasing the padding.

Const SCROLLBARS_OUTSIDE_INSET As Integer

The scrollbar style to display the scrollbars at the edge of the view,increasing the padding of the view.

Const SCROLLBARS_OUTSIDE_OVERLAY As Integer

The scrollbar style to display the scrollbars at the edge of the view,without increasing the padding.

Const SCROLLBAR_POSITION_DEFAULT As Integer

Position the scroll bar at the default position as determined by the system.

Const SCROLLBAR_POSITION_LEFT As Integer

Position the scroll bar along the left edge.

Const SCROLLBAR_POSITION_RIGHT As Integer

Position the scroll bar along the right edge.

Const SOUND_EFFECTS_ENABLED As Integer

View flag indicating whether this view should have sound effects enabledfor events such as clicking and touching.

Const STATUS_BAR_HIDDEN As Integer

This constant is deprecated.Use SYSTEM_UI_FLAG_LOW_PROFILE instead.

Const STATUS_BAR_VISIBLE As Integer

This constant is deprecated.Use SYSTEM_UI_FLAG_VISIBLE instead.

Const SYSTEM_UI_FLAG_FULLSCREEN As Integer

Flag for setSystemUiVisibility(int): View has requested to gointo the normal fullscreen mode so that its content can take over the screenwhile still allowing the user to interact with the application.

Const SYSTEM_UI_FLAG_HIDE_NAVIGATION As Integer

Flag for setSystemUiVisibility(int): View has requested that thesystem navigation be temporarily hidden.

Const SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN As Integer

Flag for setSystemUiVisibility(int): View would like its windowto be layed out as if it has requestedSYSTEM_UI_FLAG_FULLSCREEN, even if it currently hasn't.

Const SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION As Integer

Flag for setSystemUiVisibility(int): View would like its windowto be layed out as if it has requestedSYSTEM_UI_FLAG_HIDE_NAVIGATION, even if it currently hasn't.

Const SYSTEM_UI_FLAG_LAYOUT_STABLE As Integer

Flag for setSystemUiVisibility(int): When using other layoutflags, we would like a stable view of the content insets given tofitSystemWindows(Rect).

Const SYSTEM_UI_FLAG_LOW_PROFILE As Integer

Flag for setSystemUiVisibility(int): View has requested thesystem UI to enter an unobtrusive 'low profile' mode.

Const SYSTEM_UI_FLAG_VISIBLE As Integer

Special constant for setSystemUiVisibility(int): View hasrequested the system UI (status bar) to be visible (the default).

Const SYSTEM_UI_LAYOUT_FLAGS As Integer

Flags that can impact the layout in relation to system UI.

Const TEXT_ALIGNMENT_INHERIT As Integer

Const TEXT_ALIGNMENT_RESOLVED_DEFAULT As Integer

Indicates whether if the view text alignment has been resolved to gravity

Const VIEW_LOG_TAG As String

The logging tag used by this class with android.util.Log.

Const VISIBLE As Integer

This view is visible.

Subs & Functions

Sub addChildrenForAccessibility(children As ArrayList<View>)

Adds the children of a given View for accessibility.

Sub addFocusables(views As ArrayList<View>, direction As Integer, focusableMode As Integer)

Adds any focusable views that are descendants of this view (possibly including this view if it is focusable itself) to views.

Sub addFocusables2(views As ArrayList<View>, direction As Integer)

Add any focusable views that are descendants of this view (possibly including this view if it is focusable itself) to views.

Sub addOnAttachStateChangeListener(listener As OnAttachStateChangeListener)

Add a listener for attach state changes.

Sub addOnLayoutChangeListener(listener As OnLayoutChangeListener)

Add a listener that will be called when the bounds of the view change due to layout processing.

Sub addTouchables(views As ArrayList<View>)

Add any touchable views that are descendants of this view (possibly including this view if it is touchable itself) to views.

Function animate() As ViewPropertyAnimator

This method returns a ViewPropertyAnimator object, which can be used to animate specific properties on this View.

Sub announceForAccessibility(text As CharSequence)

Convenience method for sending a TYPE_ANNOUNCEMENT android.view.accessibility.AccessibilityEvent to make an announcement which is related to some sort of a context change for which none of the events representing UI transitions is a good fit.

Sub bringToFront()

Change the view's z order in the tree, so it's on top of other sibling views

Sub buildDrawingCache()

Calling this method is equivalent to calling buildDrawingCache(false).

Sub buildDrawingCache2(autoScale As Boolean)

Forces the drawing cache to be built if the drawing cache is invalid.

Sub buildLayer()

Forces this view's layer to be created and this view to be rendered into its layer.

Function callOnClick() As Boolean

Directly call any attached OnClickListener.

Function canScrollHorizontally(direction As Integer) As Boolean

Check if this view can be scrolled horizontally in a certain direction.

Function canScrollVertically(direction As Integer) As Boolean

Check if this view can be scrolled vertically in a certain direction.

Sub cancelLongPress()

Cancels a pending long press.

Function checkInputConnectionProxy(view As View) As Boolean

Called by the android.view.inputmethod.InputMethodManager when a view who is not the current input connection target is trying to make a call on the manager.

Sub clearAnimation()

Cancels any animations for this view.

Sub clearFocus()

Called when this view wants to give up focus.

Function combineMeasuredStates(curState As Integer, newState As Integer) As Integer

Merge two states as returned by getMeasuredState().

Sub computeScroll()

Called by a parent to request that a child update its values for mScrollX and mScrollY if necessary.

Function createAccessibilityNodeInfo() As AccessibilityNodeInfo

Returns an android.view.accessibility.AccessibilityNodeInfo representing this view from the point of view of an android.accessibilityservice.AccessibilityService.

Sub createContextMenu(menu As ContextMenu)

Show the context menu for this view.

Sub destroyDrawingCache()

Frees the resources used by the drawing cache.

Sub dispatchConfigurationChanged(newConfig As Configuration)

Dispatch a notification about a resource configuration change down the view hierarchy.

Sub dispatchDisplayHint(hint As Integer)

Dispatch a hint about whether this view is displayed.

Function dispatchDragEvent(event As DragEvent) As Boolean

Detects if this View is enabled and has a drag event listener.

Function dispatchGenericMotionEvent(event As MotionEvent) As Boolean

Dispatch a generic motion event.

Function dispatchKeyEvent(event As KeyEvent) As Boolean

Dispatch a key event to the next view on the focus path.

Function dispatchKeyEventPreIme(event As KeyEvent) As Boolean

Dispatch a key event before it is processed by any input method associated with the view hierarchy.

Function dispatchKeyShortcutEvent(event As KeyEvent) As Boolean

Dispatches a key shortcut event.

Function dispatchPopulateAccessibilityEvent(event As AccessibilityEvent) As Boolean

Dispatches an android.view.accessibility.AccessibilityEvent to the android.view.View first and then to its children for adding their text content to the event.

Sub dispatchSystemUiVisibilityChanged(visibility As Integer)

Dispatch callbacks to setOnSystemUiVisibilityChangeListener(View.OnSystemUiVisibilityChangeListener) down the view hierarchy.

Function dispatchTouchEvent(event As MotionEvent) As Boolean

Pass the touch screen motion event down to the target view, or this view if it is the target.

Function dispatchTrackballEvent(event As MotionEvent) As Boolean

Pass a trackball motion event down to the focused view.

Function dispatchUnhandledMove(focused As View, direction As Integer) As Boolean

This method is the last chance for the focused view and its ancestors to respond to an arrow key.

Sub dispatchWindowFocusChanged(hasFocus As Boolean)

Called when the window containing this view gains or loses window focus.

Sub dispatchWindowSystemUiVisiblityChanged(visible As Integer)

Dispatch callbacks to onWindowSystemUiVisibilityChanged(int) down the view hierarchy.

Sub dispatchWindowVisibilityChanged(visibility As Integer)

Dispatch a window visibility change down the view hierarchy.

Sub draw(canvas As Canvas)

Manually render this view (and all of its children) to the given Canvas.

Function findFocus() As View

Find the view in the hierarchy rooted at this view that currently has focus.

Function findViewById(id As Integer) As View

Look for a child view with the given id.

Function findViewWithTag(tag As Object) As View

Look for a child view with the given tag.

Sub findViewsWithText(outViews As ArrayList<View>, searched As CharSequence, flags As Integer)

Finds the Views that contain given text.

Function focusSearch(direction As Integer) As View

Find the nearest view in the specified direction that can take focus.

Sub forceLayout()

Forces this view to be laid out during the next layout pass.

Function getAccessibilityNodeProvider() As AccessibilityNodeProvider

Gets the provider for managing a virtual view hierarchy rooted at this View and reported to android.accessibilityservice.AccessibilityServices that explore the window content.

Function getAlpha() As Single

The opacity of the view.

Function getAnimation() As Animation

Get the animation currently associated with this view.

Function getApplicationWindowToken() As IBinder

Retrieve a unique token identifying the top-level "real" window of the window that this view is attached to.

Function getBackground() As Drawable

Gets the background drawable

Function getBaseline() As Integer

Return the offset of the widget's text baseline from the widget's top boundary.

Function getBottom() As Integer

Bottom position of this view relative to its parent.

Function getCameraDistance() As Single

Gets the distance along the Z axis from the camera to this view.

Function getContentDescription() As CharSequence

Gets the android.view.View description.

Function getContext() As Context

Returns the context the view is running in, through which it can access the current theme, resources, etc.

Function getDefaultSize(size As Integer, measureSpec As Integer) As Integer

Utility to return a default size.

Function getDrawableState() As Integer[]

Return an array of resource IDs of the drawable states representing the current state of the view.

Function getDrawingCache(autoScale As Boolean) As Bitmap

Returns the bitmap in which this view drawing is cached.

Function getDrawingCache2() As Bitmap

Calling this method is equivalent to calling getDrawingCache(false).

Function getDrawingCacheBackgroundColor() As Integer

Function getDrawingCacheQuality() As Integer

Returns the quality of the drawing cache.

Sub getDrawingRect(outRect As Rect)

Return the visible drawing bounds of your view.

Function getDrawingTime() As Long

Return the time at which the drawing of the view hierarchy started.

Function getFilterTouchesWhenObscured() As Boolean

Gets whether the framework should discard touches when the view's window is obscured by another visible window.

Function getFitsSystemWindows() As Boolean

Check for state of If this method returns true, the default implementation of {@link #fitSystemWindows(Rect) will be executed.

Function getFocusables(direction As Integer) As ArrayList<View>

Find and return all focusable views that are descendants of this view, possibly including this view if it is focusable itself.

Sub getFocusedRect(r As Rect)

When a view has focus and the user navigates away from it, the next view is searched for starting from the rectangle filled in by this method.

Function getGlobalVisibleRect(r As Rect, globalOffset As Point) As Boolean

If some part of this view is not clipped by any of its parents, then return that area in r in global (root) coordinates.

Function getGlobalVisibleRect2(r As Rect) As Boolean

Function getHandler() As Handler

Function getHeight() As Integer

Return the height of your view.

Sub getHitRect(outRect As Rect)

Hit rectangle in parent's coordinates

Function getHorizontalFadingEdgeLength() As Integer

Returns the size of the horizontal faded edges used to indicate that more content in this view is visible.

Function getId() As Integer

Returns this view's identifier.

Function getImportantForAccessibility() As Integer

Gets the mode for determining whether this View is important for accessibility which is if it fires accessibility events and if it is reported to accessibility services that query the screen.

Function getKeepScreenOn() As Boolean

Returns whether the screen should remain on, corresponding to the current value of KEEP_SCREEN_ON.

Function getKeyDispatcherState() As DispatcherState

Return the global android.view.KeyEvent.DispatcherState for this view's window.

Function getLayerType() As Integer

Indicates what type of layer is currently associated with this view.

Function getLayoutParams() As LayoutParams

Get the LayoutParams associated with this view.

Function getLeft() As Integer

Left position of this view relative to its parent.

Function getLocalVisibleRect(r As Rect) As Boolean

Sub getLocationInWindow(location As Integer[])

Computes the coordinates of this view in its window.

Sub getLocationOnScreen(location As Integer[])

Computes the coordinates of this view on the screen.

Function getMatrix() As Matrix

The transform matrix of this view, which is calculated based on the current roation, scale, and pivot properties.

Function getMeasuredHeight() As Integer

Like getMeasuredHeightAndState(), but only returns the raw width component (that is the result is masked by MEASURED_SIZE_MASK).

Function getMeasuredHeightAndState() As Integer

Return the full height measurement information for this view as computed by the most recent call to measure(int, int).

Function getMeasuredState() As Integer

Return only the state bits of getMeasuredWidthAndState() and getMeasuredHeightAndState(), combined into one integer.

Function getMeasuredWidth() As Integer

Like getMeasuredWidthAndState(), but only returns the raw width component (that is the result is masked by MEASURED_SIZE_MASK).

Function getMeasuredWidthAndState() As Integer

Return the full width measurement information for this view as computed by the most recent call to measure(int, int).

Function getMinimumHeight() As Integer

Returns the minimum height of the view.

Function getMinimumWidth() As Integer

Returns the minimum width of the view.

Function getNextFocusDownId() As Integer

Gets the id of the view to use when the next focus is FOCUS_DOWN.

Function getNextFocusForwardId() As Integer

Gets the id of the view to use when the next focus is FOCUS_FORWARD.

Function getNextFocusLeftId() As Integer

Gets the id of the view to use when the next focus is FOCUS_LEFT.

Function getNextFocusRightId() As Integer

Gets the id of the view to use when the next focus is FOCUS_RIGHT.

Function getNextFocusUpId() As Integer

Gets the id of the view to use when the next focus is FOCUS_UP.

Function getOnFocusChangeListener() As OnFocusChangeListener

Returns the focus-change callback registered for this view.

Function getOverScrollMode() As Integer

Returns the over-scroll mode for this view.

Function getPaddingBottom() As Integer

Returns the bottom padding of this view.

Function getPaddingLeft() As Integer

Returns the left padding of this view.

Function getPaddingRight() As Integer

Returns the right padding of this view.

Function getPaddingTop() As Integer

Returns the top padding of this view.

Function getParent() As ViewParent

Gets the parent of this view.

Function getParentForAccessibility() As ViewParent

Gets the parent for accessibility purposes.

Function getPivotX() As Single

The x location of the point around which the view is rotated and scaled.

Function getPivotY() As Single

The y location of the point around which the view is rotated and scaled.

Function getResources() As Resources

Returns the resources associated with this view.

Function getRight() As Integer

Right position of this view relative to its parent.

Function getRootView() As View

Finds the topmost view in the current view hierarchy.

Function getRotation() As Single

The degrees that the view is rotated around the pivot point.

Function getRotationX() As Single

The degrees that the view is rotated around the horizontal axis through the pivot point.

Function getRotationY() As Single

The degrees that the view is rotated around the vertical axis through the pivot point.

Function getScaleX() As Single

The amount that the view is scaled in x around the pivot point, as a proportion of the view's unscaled width.

Function getScaleY() As Single

The amount that the view is scaled in y around the pivot point, as a proportion of the view's unscaled height.

Function getScrollBarDefaultDelayBeforeFade() As Integer

Returns the delay before scrollbars fade.

Function getScrollBarFadeDuration() As Integer

Returns the scrollbar fade duration.

Function getScrollBarSize() As Integer

Returns the scrollbar size.

Function getScrollBarStyle() As Integer

Returns the current scrollbar style.

Function getScrollX() As Integer

Return the scrolled left position of this view.

Function getScrollY() As Integer

Return the scrolled top position of this view.

Function getSolidColor() As Integer

Override this if your view is known to always be drawn on top of a solid color background, and needs to draw fading edges.

Function getSystemUiVisibility() As Integer

Returns the last {@link #setSystemUiVisibility(int) that this view has requested.

Function getTag(key As Integer) As Object

Returns the tag associated with this view and the specified key.

Function getTag2() As Object

Returns this view's tag.

Function getTop() As Integer

Top position of this view relative to its parent.

Function getTouchDelegate() As TouchDelegate

Gets the TouchDelegate for this View.

Function getTouchables() As ArrayList<View>

Find and return all touchable views that are descendants of this view, possibly including this view if it is touchable itself.

Function getTranslationX() As Single

The horizontal location of this view relative to its left position.

Function getTranslationY() As Single

The horizontal location of this view relative to its top position.

Function getVerticalFadingEdgeLength() As Integer

Returns the size of the vertical faded edges used to indicate that more content in this view is visible.

Function getVerticalScrollbarPosition() As Integer

Function getVerticalScrollbarWidth() As Integer

Returns the width of the vertical scrollbar.

Function getViewTreeObserver() As ViewTreeObserver

Returns the ViewTreeObserver for this view's hierarchy.

Function getVisibility() As Integer

Returns the visibility status for this view.

Function getWidth() As Integer

Return the width of the your view.

Function getWindowSystemUiVisibility() As Integer

Returns the current system UI visibility that is currently set for the entire window.

Function getWindowToken() As IBinder

Retrieve a unique token identifying the window this view is attached to.

Function getWindowVisibility() As Integer

Returns the current visibility of the window this view is attached to (either GONE, INVISIBLE, or VISIBLE).

Sub getWindowVisibleDisplayFrame(outRect As Rect)

Retrieve the overall visible display size in which the window this view is attached to has been positioned in.

Function getX() As Single

The visual x position of this view, in pixels.

Function getY() As Single

The visual y position of this view, in pixels.

Function hasFocus() As Boolean

Returns true if this view has focus iteself, or is the ancestor of the view that has focus.

Function hasFocusable() As Boolean

Returns true if this view is focusable or if it contains a reachable View for which hasFocusable() returns true.

Function hasOnClickListeners() As Boolean

Return whether this view has an attached OnClickListener.

Function hasOverlappingRendering() As Boolean

Returns whether this View has content which overlaps.

Function hasTransientState() As Boolean

Indicates whether the view is currently tracking transient state that the app should not need to concern itself with saving and restoring, but that the framework should take special note to preserve when possible.

Function hasWindowFocus() As Boolean

Returns true if this view is in a window that currently has window focus.

Function inflate(context As Context, resource As Integer, root As ViewGroup) As View

Inflate a view from an XML resource.

Function int getResolvedLayoutDirection(who As Drawable) As abstract

A Drawable can call this to get the resolved layout direction of the who.

Sub invalidate(dirty As Rect)

Mark the area defined by dirty as needing to be drawn.

Sub invalidate2(l As Integer, t As Integer, r As Integer, b As Integer)

Mark the area defined by the rect (l,t,r,b) as needing to be drawn.

Sub invalidate3()

Invalidate the whole view.

Sub invalidateDrawable(drawable As Drawable)

Invalidates the specified Drawable.

Function isActivated() As Boolean

Indicates the activation state of this view.

Function isClickable() As Boolean

Indicates whether this view reacts to click events or not.

Function isDirty() As Boolean

True if this view has changed since the last time being drawn.

Function isDrawingCacheEnabled() As Boolean

Indicates whether the drawing cache is enabled for this view.

Function isDuplicateParentStateEnabled() As Boolean

Indicates whether this duplicates its drawable state from its parent.

Function isEnabled() As Boolean

Returns the enabled status for this view.

Function isFocusable() As Boolean

Returns whether this View is able to take focus.

Function isFocusableInTouchMode() As Boolean

When a view is focusable, it may not want to take focus when in touch mode.

Function isFocused() As Boolean

Returns true if this view has focus

Function isHapticFeedbackEnabled() As Boolean

Function isHardwareAccelerated() As Boolean

Indicates whether this view is attached to a hardware accelerated window or not.

Function isHorizontalFadingEdgeEnabled() As Boolean

Indicate whether the horizontal edges are faded when the view is scrolled horizontally.

Function isHorizontalScrollBarEnabled() As Boolean

Indicate whether the horizontal scrollbar should be drawn or not.

Function isHovered() As Boolean

Returns true if the view is currently hovered.

Function isInEditMode() As Boolean

Indicates whether this View is currently in edit mode.

Function isInTouchMode() As Boolean

Returns whether the device is currently in touch mode.

Function isLayoutRequested() As Boolean

Indicates whether or not this view's layout will be requested during the next hierarchy layout pass.

Function isLongClickable() As Boolean

Indicates whether this view reacts to long click events or not.

Function isOpaque() As Boolean

Indicates whether this View is opaque.

Function isPressed() As Boolean

Indicates whether the view is currently in pressed state.

Function isSaveEnabled() As Boolean

Indicates whether this view will save its state (that is, whether its onSaveInstanceState() method will be called).

Function isSaveFromParentEnabled() As Boolean

Indicates whether the entire hierarchy under this view will save its state when a state saving traversal occurs from its parent.

Function isScrollContainer() As Boolean

Indicates whether this view is one of the set of scrollable containers in its window.

Function isScrollbarFadingEnabled() As Boolean

Returns true if scrollbars will fade when this view is not scrolling

Function isSelected() As Boolean

Indicates the selection state of this view.

Function isShown() As Boolean

Returns the visibility of this view and all of its ancestors

Function isSoundEffectsEnabled() As Boolean

Function isVerticalFadingEdgeEnabled() As Boolean

Indicate whether the vertical edges are faded when the view is scrolled horizontally.

Function isVerticalScrollBarEnabled() As Boolean

Indicate whether the vertical scrollbar should be drawn or not.

Sub jumpDrawablesToCurrentState()

Call Drawable.jumpToCurrentState() on all Drawable objects associated with this view.

Sub layout(l As Integer, t As Integer, r As Integer, b As Integer)

Assign a size and position to a view and all of its descendants This is the second phase of the layout mechanism.

Sub measure(widthMeasureSpec As Integer, heightMeasureSpec As Integer)

This is called to find out how big a view should be.

Sub offsetLeftAndRight(offset As Integer)

Offset this view's horizontal location by the specified amount of pixels.

Sub offsetTopAndBottom(offset As Integer)

Offset this view's vertical location by the specified number of pixels.

Function performAccessibilityAction(action As Integer, arguments As Bundle) As Boolean

Performs the specified accessibility action on the view.

Function performClick() As Boolean

Call this view's OnClickListener, if it is defined.

Function performHapticFeedback(feedbackConstant As Integer) As Boolean

BZZZTT!!1! Provide haptic feedback to the user for this view.

Function performHapticFeedback2(feedbackConstant As Integer, flags As Integer) As Boolean

BZZZTT!!1! Like performHapticFeedback(int), with additional options.

Function performLongClick() As Boolean

Call this view's OnLongClickListener, if it is defined.

Sub playSoundEffect(soundConstant As Integer)

Play a sound effect for this view.

Function post(action As Runnable) As Boolean

Causes the Runnable to be added to the message queue.

Function postDelayed(action As Runnable, delayMillis As Long) As Boolean

Causes the Runnable to be added to the message queue, to be run after the specified amount of time elapses.

Sub postInvalidate(left As Integer, top As Integer, right As Integer, bottom As Integer)

Cause an invalidate of the specified area to happen on a subsequent cycle through the event loop.

Sub postInvalidate2()

Cause an invalidate to happen on a subsequent cycle through the event loop.

Sub postInvalidateDelayed(delayMilliseconds As Long, left As Integer, top As Integer, right As Integer, bottom As Integer)

Cause an invalidate of the specified area to happen on a subsequent cycle through the event loop.

Sub postInvalidateDelayed2(delayMilliseconds As Long)

Cause an invalidate to happen on a subsequent cycle through the event loop.

Sub postInvalidateOnAnimation(left As Integer, top As Integer, right As Integer, bottom As Integer)

Cause an invalidate of the specified area to happen on the next animation time step, typically the next display frame.

Sub postInvalidateOnAnimation2()

Cause an invalidate to happen on the next animation time step, typically the next display frame.

Sub postOnAnimation(action As Runnable)

Causes the Runnable to execute on the next animation time step.

Sub postOnAnimationDelayed(action As Runnable, delayMillis As Long)

Causes the Runnable to execute on the next animation time step, after the specified amount of time elapses.

Sub refreshDrawableState()

Call this to force a view to update its drawable state.

Function removeCallbacks(action As Runnable) As Boolean

Removes the specified Runnable from the message queue.

Sub removeOnAttachStateChangeListener(listener As OnAttachStateChangeListener)

Remove a listener for attach state changes.

Sub removeOnLayoutChangeListener(listener As OnLayoutChangeListener)

Remove a listener for layout changes.

Sub requestFitSystemWindows()

Ask that a new dispatch of fitSystemWindows(Rect) be performed.

Function requestFocus(direction As Integer, previouslyFocusedRect As Rect) As Boolean

Call this to try to give focus to a specific view or to one of its descendants and give it hints about the direction and a specific rectangle that the focus is coming from.

Function requestFocus2(direction As Integer) As Boolean

Call this to try to give focus to a specific view or to one of its descendants and give it a hint about what direction focus is heading.

Function requestFocus3() As Boolean

Call this to try to give focus to a specific view or to one of its descendants.

Function requestFocusFromTouch() As Boolean

Call this to try to give focus to a specific view or to one of its descendants.

Sub requestLayout()

Call this when something has changed which has invalidated the layout of this view.

Function requestRectangleOnScreen(rectangle As Rect) As Boolean

Request that a rectangle of this view be visible on the screen, scrolling if necessary just enough.

Function requestRectangleOnScreen2(rectangle As Rect, immediate As Boolean) As Boolean

Request that a rectangle of this view be visible on the screen, scrolling if necessary just enough.

Function resolveSize(size As Integer, measureSpec As Integer) As Integer

Version of resolveSizeAndState(int, int, int) returning only the MEASURED_SIZE_MASK bits of the result.

Function resolveSizeAndState(size As Integer, measureSpec As Integer, childMeasuredState As Integer) As Integer

Utility to reconcile a desired size and state, with constraints imposed by a MeasureSpec.

Sub restoreHierarchyState(container As SparseArray<Parcelable>)

Restore this view hierarchy's frozen state from the given container.

Sub saveHierarchyState(container As SparseArray<Parcelable>)

Store this view hierarchy's frozen state into the given container.

Sub scheduleDrawable(who As Drawable, what As Runnable, when As Long)

Schedules an action on a drawable to occur at a specified time.

Sub scrollBy(x As Integer, y As Integer)

Move the scrolled position of your view.

Sub scrollTo(x As Integer, y As Integer)

Set the scrolled position of your view.

Sub sendAccessibilityEvent(eventType As Integer)

Sends an accessibility event of the given type.

Sub sendAccessibilityEventUnchecked(event As AccessibilityEvent)

This method behaves exactly as sendAccessibilityEvent(int) but takes as an argument an empty android.view.accessibility.AccessibilityEvent and does not perform a check whether accessibility is enabled.

Sub setAccessibilityDelegate(delegate As AccessibilityDelegate)

Sets a delegate for implementing accessibility support via compositon as opposed to inheritance.

Sub setActivated(activated As Boolean)

Changes the activated state of this view.

Sub setAlpha(alpha As Single)

Sets the opacity of the view.

Sub setAnimation(animation As Animation)

Sets the next animation to play for this view.

Sub setBackground(background As Drawable)

Set the background to a given Drawable, or remove the background.

Sub setBackgroundColor(color As Integer)

Sets the background color for this view.

Sub setBackgroundDrawable(background As Drawable)

This method is deprecated. use setBackground(Drawable) instead

Sub setBackgroundResource(resid As Integer)

Set the background to a given resource.

Sub setBottom(bottom As Integer)

Sets the bottom position of this view relative to its parent.

Sub setCameraDistance(distance As Single)

Sets the distance along the Z axis (orthogonal to the X/Y plane on which views are drawn) from the camera to this view.

Sub setClickable(clickable As Boolean)

Enables or disables click events for this view.

Sub setContentDescription(contentDescription As CharSequence)

Sets the android.view.View description.

Sub setDrawingCacheBackgroundColor(color As Integer)

Setting a solid background color for the drawing cache's bitmaps will improve performance and memory usage.

Sub setDrawingCacheEnabled(enabled As Boolean)

Enables or disables the drawing cache.

Sub setDrawingCacheQuality(quality As Integer)

Set the drawing cache quality of this view.

Sub setDuplicateParentStateEnabled(enabled As Boolean)

Enables or disables the duplication of the parent's state into this view.

Sub setEnabled(enabled As Boolean)

Set the enabled state of this view.

Sub setFadingEdgeLength(length As Integer)

Set the size of the faded edge used to indicate that more content in this view is available.

Sub setFilterTouchesWhenObscured(enabled As Boolean)

Sets whether the framework should discard touches when the view's window is obscured by another visible window.

Sub setFitsSystemWindows(fitSystemWindows As Boolean)

Sets whether or not this view should account for system screen decorations such as the status bar and inset its content; that is, controlling whether the default implementation of fitSystemWindows(Rect) will be executed.

Sub setFocusable(focusable As Boolean)

Set whether this view can receive the focus.

Sub setFocusableInTouchMode(focusableInTouchMode As Boolean)

Set whether this view can receive focus while in touch mode.

Sub setHapticFeedbackEnabled(hapticFeedbackEnabled As Boolean)

Set whether this view should have haptic feedback for events such as long presses.

Sub setHasTransientState(hasTransientState As Boolean)

Set whether this view is currently tracking transient state that the framework should attempt to preserve when possible.

Sub setHorizontalFadingEdgeEnabled(horizontalFadingEdgeEnabled As Boolean)

Define whether the horizontal edges should be faded when this view is scrolled horizontally.

Sub setHorizontalScrollBarEnabled(horizontalScrollBarEnabled As Boolean)

Define whether the horizontal scrollbar should be drawn or not.

Sub setHovered(hovered As Boolean)

Sets whether the view is currently hovered.

Sub setId(id As Integer)

Sets the identifier for this view.

Sub setImportantForAccessibility(mode As Integer)

Sets how to determine whether this view is important for accessibility which is if it fires accessibility events and if it is reported to accessibility services that query the screen.

Sub setKeepScreenOn(keepScreenOn As Boolean)

Controls whether the screen should remain on, modifying the value of KEEP_SCREEN_ON.

Sub setLayerType(layerType As Integer, paint As Paint)

Specifies the type of layer backing this view.

Sub setLayoutParams(params As LayoutParams)

Set the layout parameters associated with this view.

Sub setLeft(left As Integer)

Sets the left position of this view relative to its parent.

Sub setLongClickable(longClickable As Boolean)

Enables or disables long click events for this view.

Sub setMinimumHeight(minHeight As Integer)

Sets the minimum height of the view.

Sub setMinimumWidth(minWidth As Integer)

Sets the minimum width of the view.

Sub setNextFocusDownId(nextFocusDownId As Integer)

Sets the id of the view to use when the next focus is FOCUS_DOWN.

Sub setNextFocusForwardId(nextFocusForwardId As Integer)

Sets the id of the view to use when the next focus is FOCUS_FORWARD.

Sub setNextFocusLeftId(nextFocusLeftId As Integer)

Sets the id of the view to use when the next focus is FOCUS_LEFT.

Sub setNextFocusRightId(nextFocusRightId As Integer)

Sets the id of the view to use when the next focus is FOCUS_RIGHT.

Sub setNextFocusUpId(nextFocusUpId As Integer)

Sets the id of the view to use when the next focus is FOCUS_UP.

Sub setOnClickListener(l As OnClickListener)

Register a callback to be invoked when this view is clicked.

Sub setOnCreateContextMenuListener(l As OnCreateContextMenuListener)

Register a callback to be invoked when the context menu for this view is being built.

Sub setOnDragListener(l As OnDragListener)

Register a drag event listener callback object for this View.

Sub setOnFocusChangeListener(l As OnFocusChangeListener)

Register a callback to be invoked when focus of this view changed.

Sub setOnGenericMotionListener(l As OnGenericMotionListener)

Register a callback to be invoked when a generic motion event is sent to this view.

Sub setOnHoverListener(l As OnHoverListener)

Register a callback to be invoked when a hover event is sent to this view.

Sub setOnKeyListener(l As OnKeyListener)

Register a callback to be invoked when a hardware key is pressed in this view.

Sub setOnLongClickListener(l As OnLongClickListener)

Register a callback to be invoked when this view is clicked and held.

Sub setOnSystemUiVisibilityChangeListener(l As OnSystemUiVisibilityChangeListener)

Set a listener to receive callbacks when the visibility of the system bar changes.

Sub setOnTouchListener(l As OnTouchListener)

Register a callback to be invoked when a touch event is sent to this view.

Sub setOverScrollMode(overScrollMode As Integer)

Set the over-scroll mode for this view.

Sub setPadding(left As Integer, top As Integer, right As Integer, bottom As Integer)

Sets the padding.

Sub setPivotX(pivotX As Single)

Sets the x location of the point around which the view is rotated and scaled.

Sub setPivotY(pivotY As Single)

Sets the y location of the point around which the view is rotated and scaled.

Sub setPressed(pressed As Boolean)

Sets the pressed state for this view.

Sub setRight(right As Integer)

Sets the right position of this view relative to its parent.

Sub setRotation(rotation As Single)

Sets the degrees that the view is rotated around the pivot point.

Sub setRotationX(rotationX As Single)

Sets the degrees that the view is rotated around the horizontal axis through the pivot point.

Sub setRotationY(rotationY As Single)

Sets the degrees that the view is rotated around the vertical axis through the pivot point.

Sub setSaveEnabled(enabled As Boolean)

Controls whether the saving of this view's state is enabled (that is, whether its onSaveInstanceState() method will be called).

Sub setSaveFromParentEnabled(enabled As Boolean)

Controls whether the entire hierarchy under this view will save its state when a state saving traversal occurs from its parent.

Sub setScaleX(scaleX As Single)

Sets the amount that the view is scaled in x around the pivot point, as a proportion of the view's unscaled width.

Sub setScaleY(scaleY As Single)

Sets the amount that the view is scaled in Y around the pivot point, as a proportion of the view's unscaled width.

Sub setScrollBarDefaultDelayBeforeFade(scrollBarDefaultDelayBeforeFade As Integer)

Define the delay before scrollbars fade.

Sub setScrollBarFadeDuration(scrollBarFadeDuration As Integer)

Define the scrollbar fade duration.

Sub setScrollBarSize(scrollBarSize As Integer)

Define the scrollbar size.

Sub setScrollBarStyle(style As Integer)

Specify the style of the scrollbars.

Sub setScrollContainer(isScrollContainer As Boolean)

Change whether this view is one of the set of scrollable containers in its window.

Sub setScrollX(value As Integer)

Set the horizontal scrolled position of your view.

Sub setScrollY(value As Integer)

Set the vertical scrolled position of your view.

Sub setScrollbarFadingEnabled(fadeScrollbars As Boolean)

Define whether scrollbars will fade when the view is not scrolling.

Sub setSelected(selected As Boolean)

Changes the selection state of this view.

Sub setSoundEffectsEnabled(soundEffectsEnabled As Boolean)

Set whether this view should have sound effects enabled for events such as clicking and touching.

Sub setSystemUiVisibility(visibility As Integer)

Request that the visibility of the status bar or other screen/window decorations be changed.

Sub setTag(key As Integer, tag As Object)

Sets a tag associated with this view and a key.

Sub setTag2(tag As Object)

Sets the tag associated with this view.

Sub setTop(top As Integer)

Sets the top position of this view relative to its parent.

Sub setTouchDelegate(delegate As TouchDelegate)

Sets the TouchDelegate for this View.

Sub setTranslationX(translationX As Single)

Sets the horizontal location of this view relative to its left position.

Sub setTranslationY(translationY As Single)

Sets the vertical location of this view relative to its top position.

Sub setVerticalFadingEdgeEnabled(verticalFadingEdgeEnabled As Boolean)

Define whether the vertical edges should be faded when this view is scrolled vertically.

Sub setVerticalScrollBarEnabled(verticalScrollBarEnabled As Boolean)

Define whether the vertical scrollbar should be drawn or not.

Sub setVerticalScrollbarPosition(position As Integer)

Set the position of the vertical scroll bar.

Sub setVisibility(visibility As Integer)

Set the enabled state of this view.

Sub setWillNotCacheDrawing(willNotCacheDrawing As Boolean)

When a View's drawing cache is enabled, drawing is redirected to an offscreen bitmap.

Sub setWillNotDraw(willNotDraw As Boolean)

If this view doesn't do any drawing on its own, set this flag to allow further optimizations.

Sub setX(x As Single)

Sets the visual x position of this view, in pixels.

Sub setY(y As Single)

Sets the visual y position of this view, in pixels.

Function showContextMenu() As Boolean

Bring up the context menu for this view.

Function startActionMode(callback As Callback) As ActionMode

Start an action mode.

Sub startAnimation(animation As Animation)

Start the specified animation now.

Function startDrag(data As ClipData, shadowBuilder As DragShadowBuilder, myLocalState As Object, flags As Integer) As Boolean

Starts a drag and drop operation.

Sub unscheduleDrawable(who As Drawable)

Unschedule any events associated with the given Drawable.

Sub unscheduleDrawable2(who As Drawable, what As Runnable)

Cancels a scheduled action on a drawable.

Function willNotCacheDrawing() As Boolean

Returns whether or not this View can cache its drawing or not.

Function willNotDraw() As Boolean

Returns whether or not this View draws on its own.

Events

Event onCheckIsTextEditor() As Boolean

Check whether the called view is a text editor, in which case it would make sense to automatically display a soft input window for it.

Event onCreateInputConnection(outAttrs As EditorInfo) As InputConnection

Create a new InputConnection for an InputMethod to interact with the view.

Event onDragEvent(event As DragEvent) As Boolean

Handles drag events sent by the system following a call to startDrag().

Event onFilterTouchEventForSecurity(event As MotionEvent) As Boolean

Filter the touch event to apply security policies.

Event onFinishTemporaryDetach()

Called after onStartTemporaryDetach() when the container is done changing the view.

Event onGenericMotionEvent(event As MotionEvent) As Boolean

Implement this method to handle generic motion events.

Event onHoverChanged(hovered As Boolean)

Implement this method to handle hover state changes.

Event onHoverEvent(event As MotionEvent) As Boolean

Implement this method to handle hover events.

Event onInitializeAccessibilityEvent(event As AccessibilityEvent)

Initializes an android.view.accessibility.AccessibilityEvent with information about this View which is the event source.

Event onInitializeAccessibilityNodeInfo(info As AccessibilityNodeInfo)

Initializes an android.view.accessibility.AccessibilityNodeInfo with information about this view.

Event onKeyDown(keyCode As Integer, event As KeyEvent) As Boolean

Default implementation of KeyEvent.Callback.onKeyDown(): perform press of the view when KEYCODE_DPAD_CENTER or KEYCODE_ENTER is released, if the view is enabled and clickable.

Event onKeyLongPress(keyCode As Integer, event As KeyEvent) As Boolean

Default implementation of KeyEvent.Callback.onKeyLongPress(): always returns false (doesn't handle the event).

Event onKeyMultiple(keyCode As Integer, repeatCount As Integer, event As KeyEvent) As Boolean

Default implementation of KeyEvent.Callback.onKeyMultiple(): always returns false (doesn't handle the event).

Event onKeyPreIme(keyCode As Integer, event As KeyEvent) As Boolean

Handle a key event before it is processed by any input method associated with the view hierarchy.

Event onKeyShortcut(keyCode As Integer, event As KeyEvent) As Boolean

Called on the focused view when a key shortcut event is not handled.

Event onKeyUp(keyCode As Integer, event As KeyEvent) As Boolean

Default implementation of KeyEvent.Callback.onKeyUp(): perform clicking of the view when KEYCODE_DPAD_CENTER or KEYCODE_ENTER is released.

Event onPopulateAccessibilityEvent(event As AccessibilityEvent)

Called from dispatchPopulateAccessibilityEvent(AccessibilityEvent) giving a chance to this View to populate the accessibility event with its text content.

Event onScreenStateChanged(screenState As Integer)

This method is called whenever the state of the screen this view is attached to changes.

Event onStartTemporaryDetach()

This is called when a container is going to temporarily detach a child, with ViewGroup.detachViewFromParent.

Event onTouchEvent(event As MotionEvent) As Boolean

Implement this method to handle touch screen motion events.

Event onTrackballEvent(event As MotionEvent) As Boolean

Implement this method to handle trackball motion events.

Event onWindowFocusChanged(hasWindowFocus As Boolean)

Called when the window containing this view gains or loses focus.

Event onWindowSystemUiVisibilityChanged(visible As Integer)

Override to find out when the window's requested system UI visibility has changed, that is the value returned by getWindowSystemUiVisibility().

Signals

Signal onClick(v As View)

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

Controls

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

Keywords

Keyword </java>

---

Keyword </string>

---

Keyword <java>

---

Keyword <string>

---

Keyword Action

---

Keyword Alias

Declare statements: Used to extend the language and gain direct access to the Cocoa library or other Objective-C files of the current project.

---

Keyword As

Dim VARIABLENAME As VARIABLETYPE
Sub SUBNAME(ByRef VARIABLENAME As VARIABLETYPE)

It is used whenever you declare variables. After As, you write the type of the variable you currently declare. See the manual for more information on this.

See also Dim

---

Keyword Break

Immediatily leaves the current loop.

---

Keyword ByRef

Sub SUBNAME(ByRef VARIABLENAME As VARIABLETYPE)

Defines the given variable to the sub or function, to be handled by reference. This means, that chaning the value of this varialbe affects the original variable as well. See the manual for more information on this.

---

Keyword ByVal

Sub SUBNAME(ByVal VARIABLENAME As VARIABLETYPE)

Defines the given variable to the sub or function, to be handled by value. This means, that chaning the value of this varialbe DOES NOT affect the original variable as well. See the manual for more information on this.

---

Keyword Call

---

Keyword Case

Select Case EXPRESSION...Case EXPRESSION...End Select
Select Case EXPRESSION...Case EXPRESSION To EXPRESSION...End Select
Select Case EXPRESSION...Case Is OPERATOR EXPRESSION...End Select
Select Case EXPRESSION...Case Else...End Select

It is used for Select Case, which introduces a multi-line conditional selection statement.

See also Select

---

Keyword Catch

---

Keyword Class

Classes are needed, when you would like use (custom) objects.

---

Keyword Const

Const NAME [As TYPE] = EXPRESSION

Declares a constants.
Constants are similar to variables but they cannot change values. When you declare a constant you assign a value to it that annot be altered during lifetime of your program.

See also Dim

---

Keyword Continue

Immediatily tests loop condition of the current loop.

---

Keyword Declare

Used to extend the language and gain direct access to the Cocoa library or other Objective-C files of the current project.

---

Keyword Dim

Dim VARIABLENAME[ARRAY] [As VARIABLETYPE] {[, VARIABLENAME[ARRAY] [As VARIABLETYPE]]}

Before using variables, you must declare them. You must define the name and the data type of a variable. The 'Dim'-statement declares a variable. See the manual for more information.

See also Const

---

Keyword Do

Do...Loop Until EXPRESSION
Do While EXPRESSION...Loop

Loop-statements

The statements that control decisions and loops in are called control structures. Normally every command is executed only one time but in many cases it may be useful to run a command several times until a defined state has been reached. Loops repeat commands depending upon a condition. Some loops repeat commands while a condition is 'True,' other loops repeat commands while a condition is 'False.' There are other loops repeating a fixed number of times and some repeat for all elements of a collection.
There are two different ways to use the keyword 'Do' in order to test a condition within a 'Do...Loop'-statement. You can test the condition before the commands inside the loop are executed or you can test the condition after the commands of the loop have been executed at least once. If the condition is 'True' ( in the following procedure 'SubBefore') the commands inside the loop execute.

---

Keyword Else

If EXPRESSION Then...Else If EXPRESSION...Else...End If

A single decision is used to execute a set of statements if a condition is set ('If'-statement). If the condition is 'True' then the statements after the 'Then' are executed and the statements after the 'Else' are skipped. If the condition is 'False', the statements after the 'Else' are executed.

See also If

---

Keyword End

End Sub
End Function
End Type
End Event
End Enum
End Delegate
End Action
End IBAction
End If
End Select

It is used to close the current sub, function or other language structure. See the list above.

---

Keyword Event

Events are automatically called by the runtime. The difference between events and actions is that events are overriding the super class event function.

---

Keyword Exception

---

Keyword Exit

Exit For

Explicit leave of for loop. Note: That Exit For works only within non-nested code.

Exit Do

Explicit leave of do loop. Note: That Exit For works only within non-nested code.

Exit Sub

Explicit leave of sub.

Exit Function

Explicit leave of function.

Exit Event

Explicit leave of event procedure.

Exit Delegate

Explicit leave of delegate procedure.

Exit IBAction

Explicit leave of IBAction procedure.

---

Keyword False

The boolean literal used for the false value.

See also True

---

Keyword Finally

---

Keyword For

For VARIABLENAME = EXPRESSION To EXPRESSION [Step EXPRESSION]
Next

The statements that control decisions and loops are called control structures. Normally every command is executed only one time but in many cases it may be useful to run a command several times until a defined state has been reached. Loops repeat commands depending upon a condition. Some loops repeat commands while a condition is 'True', other loops repeat commands while a condition is 'False'. There are other loops repeating a fixed number of times and some repeat for all elements of a collection. The For-Next loop is useful when you know how often statements should be repeated. For-Next defines a loop that runs a specified number of times.

See also Next

---

Keyword Function

Function NAME([ARGUMENTS]) [As RETURNTYPE]...End Function

Is a part of a program, returning a value depending on calculation inside the function. A function-procedure can have arguments, variables, expressions, or constants that are given to it when it get called. Function-procedures return values.

See also Sub

---

Keyword Global

Global Dim VARIABLENAME [As VARIABLETYPE] [= EXPRESSION]

Unlike other variables and procedures of a file, global variables and procedures can be access just by its name only.

See also Dim, Public

---

Keyword IIf

IIf(EXPRESSION, THENRETURNEXPRESSION, ELSERETURNEXPRESSION)

IIf returns a value of two values depending on an expression.

---

Keyword If

A single decision is used to execute a set of statements if a condition is set ('If'-statement). If the condition is 'True' then the statements after the 'Then' are executed and the statements after the 'Else' are skipped. If the condition is 'False', the statements after the 'Else' are executed.

See also Then, Else

---

Keyword Is

Select Case EXPRESSION...Case Is OPERATOR EXPRESSION...End Select

Used in a select case statement for comparision.

---

Keyword Iterate

Iterate For

Manually test loop condition for a 'For'-loop. Note: That Iterate For works only within non-nested code.

Iterate Do

Manually test loop condition of a 'Do'-loop. Note: That Iterate Do works only within non-nested code.

---

Keyword Loop

Do
Loop Until EXPRESSION
Do While EXPRESSION
Loop

Loop-statements. See Do fore more information.

---

Keyword Me

Use current instance or object. The keyword 'Me' references the current instance (or object) in which the code is currently executed. Normally it is the current class (user defined class or form class).

---

Keyword Mid

Mid(STRINGVARIABLE, Position As Integer, Length As Integer) = {STRINGEXPRESSION | ASCII-Code}

Replaces text inside a string by another text.

---

Keyword Module

Modules are usefull when you would like to organize functions and subs. A simple application can consist of only one form while the complete source code is in one form module. As your applications grow larger you probably would like to use the same code at different places. To do so, place this code in a global module file as it is accessible by the entire application. You code is stored in classes or modules. You can archive your code within modules. Every module consists of the declaration part and the procedures you have inserted. A module can contain: Declarations - for variables, types, enumerations and constants; Procedures - which are not assigned to a special event or object.
You can create as many procedures as you want, e.g. sub-procedures without return value or function-procedures. You must not put several classes or modules in one file.
See the manual for more information.

See also Class

---

Keyword Next

For VARIABLENAME = EXPRESSION To EXPRESSION [Step EXPRESSION]
Next

The statements that control decisions and loops are called control structures. Normally every command is executed only one time but in many cases it may be useful to run a command several times until a defined state has been reached. Loops repeat commands depending upon a condition. Some loops repeat commands while a condition is 'True', other loops repeat commands while a condition is 'False'. There are other loops repeating a fixed number of times and some repeat for all elements of a collection. The For-Next loop is useful when you know how often statements should be repeated. For-Next defines a loop that runs a specified number of times.

See also For

---

Keyword Null

---

Keyword Outlet

---

Keyword Private

Private VARIABLENAME[ARRAY] [As VARIABLETYPE] [, VARIABLENAME[ARRAY] [As VARIABLETYPE]]

Before using variables, you must declare them. You must define the name and the data type of a variable. Use of the 'Private'-Statement Use the 'Private'-statement to declare private variables in module scope or class scope, making the variable accessible only from the same scope (module scope, all module procedures, class scope, all class methods)
See the manual for more information.

See also Class, Module, Dim, Public, Global

---

Keyword Public

Public VARIABLENAME[ARRAY] [As VARIABLETYPE] [, VARIABLENAME[ARRAY] [As VARIABLETYPE]]

You can use the 'Public'-statement to declare public variables in module scope or class scope, making the variable accessible from everywhere.
See the manual for more information.

See also Class, Module, Dim, Private, Global

---

Keyword Return

Return [EXPRESSION]

Returns a value (for functions only) and leaves the current function/sub.

---

Keyword Select

Select Case EXPRESSION...Case EXPRESSION...End Select
Select Case EXPRESSION...Case EXPRESSION To EXPRESSION...End Select
Select Case EXPRESSION...Case Is OPERATOR EXPRESSION...End Select
Select Case EXPRESSION...Case Else...End Select

It is used for Select Case, which introduces a multi-line conditional selection statement.

See also Case

---

Keyword Signal

Signal SIGNALNAME(ARGUMENTS)...End Signal

The difference between events and signals is that events are overriding the super class event function, but signal uses the listener feature of Android.

---

Keyword Static

Static Dim VARIABLENAME[ARRAY] [As VARIABLETYPE] [, VARIABLENAME[ARRAY] [As VARIABLETYPE]]

Before using variables, you must declare them. You must define the name and the data type of a variable. Static is a modifier to declare variables with a special feature: Static outside a class, but inside a procedure (sub or function) or method. If you use a 'Static'-statement instead of a 'Dim'-statement, the variable is declared as local static variable. The variable, once it has been declared, it is not destroyed by leaving the procedure. The next time the procedure is entered, the value of the variable still exists. Therefore, a local static variable is only one time declared when using recursive calls of a procedure.

---

Keyword Step

Enables you to control the value of increment or decrement of a loop counter variable of a For-Next-Loop.

---

Keyword Sub

Sub SUBNAME(ARGUMENTS)...End Sub

Is a part of your program containing commands. A sub-procedure can have arguments, variables, expressions, or constants that are given to the sub-procedure when calling it.

See also Function

---

Keyword Super

Reserved.

---

Keyword SuperClass

---

Keyword Then

If EXPRESSION Then...Else If EXPRESSION...Else...End If

A single decision is used to execute a set of statements if a condition is set ('If'-statement). If the condition is 'True' then the statements after the 'Then' are executed and the statements after the 'Else' are skipped. If the condition is 'False', the statements after the 'Else' are executed.

---

Keyword Then

If EXPRESSION Then...Else If EXPRESSION...Else...End If

A single decision is used to execute a set of statements if a condition is set ('If'-statement). If the condition is 'True' then the statements after the 'Then' are executed and the statements after the 'Else' are skipped. If the condition is 'False', the statements after the 'Else' are executed.

---

Keyword To

For VARIABLENAME = EXPRESSION To EXPRESSION [Step EXPRESSION]
Next

The statements that control decisions and loops are called control structures. Normally every command is executed only one time but in many cases it may be useful to run a command several times until a defined state has been reached. Loops repeat commands depending upon a condition. Some loops repeat commands while a condition is 'True', other loops repeat commands while a condition is 'False'. There are other loops repeating a fixed number of times and some repeat for all elements of a collection. The For-Next loop is useful when you know how often statements should be repeated. For-Next defines a loop that runs a specified number of times.

---

Keyword True

The boolean literal used for the true value.

See also False

---

Keyword Try

---

Keyword Until

Do
Loop Until EXPRESSION
Do While EXPRESSION
Loop

The statements that control decisions and loops are called control structures. Normally every command is executed only one time but in many cases it may be useful to run a command several times until a defined state has been reached. Loops repeat commands depending upon a condition. Some loops repeat commands while a condition is 'True,' other loops repeat commands while a condition is 'False.' There are other loops repeating a fixed number of times and some repeat for all elements of a collection.
Use the following loops when you are not sure how often a command should be repeated: 'Do', 'While', 'Loop'or 'Until'. There are two different ways to use the keyword 'While' in order to test a condition within a 'Do
Loop'-statement. You can test the condition before the commands inside the loop are executed or you can test the condition after the commands of the loop have been executed at least once. If the condition is 'True' ( in the following procedure 'SubBefore') the commands inside the loop execute.

---

Keyword Var

Var is an alias for Dim

See also Var

---

Keyword While

While...End While

Do While EXPRESSION
Loop

Loop-statement. See Do fore more information.

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

Types

Type Boolean

---

Type Double

---

Type Float

---

Type Integer

---

Type Long

---

Type Object

An alias for id.

---

Type Single

It is internally a float object.

---

Type String

It is internally a string object.

---

Type id

An alias for Object.

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

Constants

Constant CaseInsensitive

---

Constant CaseSensitive

---

Constant vbCr

---

Constant vbCrLf

---

Constant vbLf

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

Operators

Operator !

---

Operator $

---

Operator &

---

Operator '

---

Operator (

---

Operator )

---

Operator *

---

Operator +

---

Operator -

---

Operator .

---

Operator /

---

Operator :

---

Operator <=

---

Operator <>

---

Operator =

---

Operator =

---

Operator ==

---

Operator ===

---

Operator >=

---

Operator And

And operator

---

Operator AndAlso

---

Operator Flip

---

Operator Mod

---

Operator Not

---

Operator Or

---

Operator OrElse

---

Operator Shl

---

Operator Shr

---

Operator Xor

---

Operator \

---

Operator ^

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---